Struct yrs::Store

pub struct Store { /* private fields */ }

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

impl Store

pub fn pending_update(&self) -> Option<&PendingUpdate>

If there are any missing updates, this method will return a pending update which contains updates waiting for their predecessors to arrive in order to be integrated.

pub fn pending_ds(&self) -> Option<&DeleteSet>

If there are some delete updates waiting for missing updates to arrive in order to be applied, this method will return them.

pub fn is_subdoc(&self) -> bool

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.

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.

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>

pub fn subdocs(&self) -> SubdocsIter<'_>

Returns a collection of sub documents linked within the structures of this document store.

pub fn subdoc_guids(&self) -> SubdocGuids<'_>

Returns a collection of globally unique identifiers of sub documents linked within the structures of this document store.

pub fn is_alive(&self, branch_ptr: &BranchPtr) -> bool

Trait Implementations

impl Debug for Store

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Store

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for Store

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.

fn encode_v1(&self) -> Vec<u8>

Helper function for encoding 1st version of lib0 encoding.

fn encode_v2(&self) -> Vec<u8>

Helper function for encoding 1st version of lib0 encoding.