pub struct Store { /* private fields */ }Expand description
Store is a core element of a document. It contains all of the information, like block store map of root types, pending updates waiting to be applied once a missing update information arrives and all subscribed callbacks.
Implementations§
source§impl Store
impl Store
pub fn is_subdoc(&self) -> bool
sourcepub fn get_local_state(&self) -> u32
pub fn get_local_state(&self) -> u32
Get the latest clock sequence number observed and integrated into a current store client. This is exclusive value meaning it describes a clock value of the beginning of the next block that’s about to be inserted. You cannot use that clock value to find any existing block content.
sourcepub fn encode_state_from_snapshot<E: Encoder>(
&self,
snapshot: &Snapshot,
encoder: &mut E
) -> Result<(), Error>
pub fn encode_state_from_snapshot<E: Encoder>(
&self,
snapshot: &Snapshot,
encoder: &mut E
) -> Result<(), Error>
Encodes all changes from current transaction block store up to a given snapshot.
This enables to encode state of a document at some specific point in the past.
sourcepub fn encode_diff<E: Encoder>(&self, sv: &StateVector, encoder: &mut E)
pub fn encode_diff<E: Encoder>(&self, sv: &StateVector, encoder: &mut E)
Compute a diff to sync with another client.
This is the most efficient method to sync with another client by only syncing the differences.
The sync protocol in Yrs/js is:
- Send StateVector to the other client.
- The other client comutes a minimal diff to sync by using the StateVector.
pub fn get_type_from_path(&self, path: &Path) -> Option<BranchPtr>
sourcepub fn subdocs(&self) -> SubdocsIter<'_>
pub fn subdocs(&self) -> SubdocsIter<'_>
Returns a collection of sub documents linked within the structures of this document store.
sourcepub fn subdoc_guids(&self) -> SubdocGuids<'_>
pub fn subdoc_guids(&self) -> SubdocGuids<'_>
Returns a collection of globally unique identifiers of sub documents linked within the structures of this document store.
Trait Implementations§
source§impl Encode for Store
impl Encode for Store
source§fn encode<E: Encoder>(&self, encoder: &mut E)
fn encode<E: Encoder>(&self, encoder: &mut E)
Encodes the document state to a binary format.
Document updates are idempotent and commutative. Caveats:
- It doesn’t matter in which order document updates are applied.
- As long as all clients receive the same document updates, all clients end up with the same content.
- Even if an update contains known information, the unknown information is extracted and integrated into the document structure.