y-crdt · Horusiath · May 20, 2025 · May 20, 2025
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/tests-wasm/package-lock.json b/tests-wasm/package-lock.json
diff --git a/yffi/Cargo.toml b/yffi/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "yffi"
-version = "0.23.3"
+version = "0.23.4"
 authors = ["Kevin Jahns <kevin.jahns@protonmail.com>", "Bartosz Sypytkowski <b.sypytkowski@gmail.com>"]
 keywords = ["crdt", "c-ffi", "yrs"]
 edition = "2018"
@@ -12,7 +12,7 @@ description = "Bindings for the Yrs native C foreign function interface"
 [dev-dependencies]
 
 [dependencies]
-yrs = { path = "../yrs", version = "0.23.3", features = ["weak"] }
+yrs = { path = "../yrs", version = "0.23.4", features = ["weak"] }
 serde_json = { version = "1.0" }
 
 [lib]

diff --git a/yrs/Cargo.toml b/yrs/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "yrs"
-version = "0.23.3"
+version = "0.23.4"
 description = "High performance implementation of the Yjs CRDT"
 license = "MIT"
 authors = ["Kevin Jahns <kevin.jahns@pm.me>", "Bartosz Sypytkowski <b.sypytkowski@gmail.com>"]

diff --git a/yrs/src/transaction.rs b/yrs/src/transaction.rs
@@ -55,38 +55,105 @@ pub trait ReadTxn: Sized {
         self.store().encode_state_from_snapshot(snapshot, encoder)
     }
 
-    /// Encodes the difference between remove peer state given its `state_vector` and the state
-    /// of a current local peer
+    /// Encodes the difference between remote peer state given its `state_vector` and the state
+  
10000
  /// of a current local peer.
+    ///
+    /// # Differences between alternative methods
+    ///
+    /// - [Self::encode_state_as_update] encodes full document state including pending updates and
+    /// entire delete set.
+    /// - [Self::encode_diff] encodes only the difference between the current state and
+    /// the given state vector, including entire delete set. Pending updates are not included.
+    /// - [TransactionMut::encode_update] encodes only inserts and deletes made within the scope
+    /// of the current transaction.
     fn encode_diff<E: Encoder>(&self, state_vector: &StateVector, encoder: &mut E) {
         self.store().encode_diff(state_vector, encoder)
     }
 
+    /// Encodes the difference between remote peer state given its `state_vector` and the state
+    /// of a current local peer, using lib0 v1 encoding.
+    ///
+    /// # Differences between alternative methods
+    ///
+    /// - [Self::encode_state_as_update_v1] encodes full document state including pending updates
+    /// and entire delete set.
+    /// - [Self::encode_diff_v1] encodes only the difference between the current state and
+    /// the given state vector, including entire delete set. Pending updates are not included.
+    /// - [TransactionMut::encode_update_v1] encodes only inserts and deletes made within the scope
+    /// of the current transaction.
     fn encode_diff_v1(&self, state_vector: &StateVector) -> Vec<u8> {
         let mut encoder = EncoderV1::new();
         self.encode_diff(state_vector, &mut encoder);
         encoder.to_vec()
     }
 
+    /// Encodes the difference between remote peer state given its `state_vector` and the state
+    /// of a current local peer, using lib0 v2 encoding.
+    ///
+    /// # Differences between alternative methods
+    ///
+    /// - [Self::encode_state_as_update_v2] encodes full document state including pending updates
+    /// and entire delete set.
+    /// - [Self::encode_diff_v2] encodes only the difference between the current state and
+    /// the given state vector, including entire delete set. Pending updates are not included.
+    /// - [TransactionMut::encode_update_v2] encodes only inserts and deletes made within the scope
+    /// of the current transaction.
     fn encode_diff_v2(&self, state_vector: &StateVector) -> Vec<u8> {
         let mut encoder = EncoderV2::new();
         self.encode_diff(state_vector, &mut encoder);
         encoder.to_vec()
     }
 
+    /// Encodes the difference between remote peer state given its `state_vector` and the state
+    /// of a current local peer. Also includes pending updates which were not yet integrated into
+    /// the main document state and entire delete set.
+    ///
+    /// # Differences between alternative methods
+    ///
+    /// - [Self::encode_state_as_update] encodes full document state including pending updates and
+    /// entire delete set.
+    /// - [Self::encode_diff] encodes only the difference between the current state and
+    /// the given state vector, including entire delete set. Pending updates are not included.
+    /// - [TransactionMut::encode_update] encodes only inserts and deletes made within the scope
+    /// of the current transaction.
     fn encode_state_as_update<E: Encoder>(&self, sv: &StateVector, encoder: &mut E) {
         let store = self.store();
         store.write_blocks_from(sv, encoder);
         let ds = DeleteSet::from(&store.blocks);
         ds.encode(encoder);
     }
 
+    /// Encodes the difference between remote peer state given its `state_vector` and the state
+    /// of a current local peer, using lib0 v1 encoding. Also includes pending updates which were
+    /// not yet integrated into the main document state and entire delete set.
+    ///
+    /// # Differences between alternative methods
+    ///
+    /// - [Self::encode_state_as_update_v1] encodes full document state including pending updates
+    /// and entire delete set.
+    /// - [Self::encode_diff_v1] encodes only the difference between the current state and
+    /// the given state vector, including entire delete set. Pending updates are not included.
+    /// - [TransactionMut::encode_update_v1] encodes only inserts and deletes made within the scope
+    /// of the current transaction.
     fn encode_state_as_update_v1(&self, sv: &StateVector) -> Vec<u8> {
         let mut encoder = EncoderV1::new();
         self.encode_state_as_update(sv, &mut encoder);
         // check for pending data
         merge_pending_v1(encoder.to_vec(), self.store())
     }
 
+    /// Encodes the difference between remote peer state given its `state_vector` and the state
+    /// of a current local peer, using lib0 v2 encoding. Also includes pending updates which were
+    /// not yet integrated into the main document state and entire delete set.
+    ///
+    /// # Differences between alternative methods
+    ///
+    /// - [Self::encode_state_as_update_v2] encodes full document state including pending updates
+    /// and entire delete set.
+    /// - [Self::encode_diff_v2] encodes only the difference between the current state and
+    /// the given state vector, including entire delete set. Pending updates are not included.
+    /// - [TransactionMut::encode_update_v2] encodes only inserts and deletes made within the scope
+    /// of the current transaction.
     fn encode_state_as_update_v2(&self, sv: &StateVector) -> Vec<u8> {
         let mut encoder = EncoderV2::new();
         self.encode_state_as_update(sv, &mut encoder);

diff --git a/ywasm/Cargo.toml b/ywasm/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ywasm"
-version = "0.23.3"
+version = "0.23.4"
 authors = ["Kevin Jahns <kevin.jahns@protonmail.com>", "Bartosz Sypytkowski <b.sypytkowski@gmail.com>"]
 keywords = ["crdt", "wasm", "yrs"]
 edition = "2018"
@@ -17,7 +17,7 @@ crate-type = ["cdylib", "rlib"]
 default = ["console_error_panic_hook"]
 
 [dependencies]
-yrs = { path = "../yrs", version = "0.23.3", features = ["weak"] }
+yrs = { path = "../yrs", version = "0.23.4", features = ["weak"] }
 wasm-bindgen = { version = "0.2" }
 serde = { version = "1.0", features = ["derive", "rc"] }
 serde_json = "1.0"