Struct yrs::TransactionMut

pub struct TransactionMut<'doc> { /* private fields */ }

Implementations

impl<'doc> TransactionMut<'doc>

pub fn before_state(&self) -> &StateVector

Corresponding document’s state vector at the moment when current transaction was created.

pub fn after_state(&self) -> &StateVector

Current document state vector which includes changes made by this transaction.

pub fn delete_set(&self) -> &DeleteSet

Data about deletions performed in the scope of current transaction.

pub fn encode_update_v1(&self) -> Vec<u8>

Encodes changes made within the scope of the current transaction using lib0 v1 encoding.

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.

pub fn encode_update_v2(&self) -> Vec<u8>

Encodes changes made within the scope of the current transaction using lib0 v2 encoding.

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.

pub fn encode_update<E: Encoder>(&self, encoder: &mut E)

Encodes changes made within the scope of the current transaction.

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.

pub fn apply_update(&mut self, update: Update)

Applies a deserialized update contents into a document owning current transaction.

pub fn commit(&mut self)

Commits current transaction. This step involves cleaning up and optimizing changes performed during lifetime of a transaction. Such changes include squashing delete sets data or squashing blocks that have been appended one after another to preserve memory.

This step is performed automatically when a transaction is about to be dropped (its life scope comes to an end).

Trait Implementations

impl<'doc> Drop for TransactionMut<'doc>

fn drop(&mut self)

Executes the destructor for this type.

impl<'doc> ReadTxn for TransactionMut<'doc>

fn store(&self) -> &Store

fn state_vector(&self) -> StateVector

Returns state vector describing current state of the updates.

fn snapshot(&self) -> Snapshot

Returns a snapshot which describes a current state of updates and removals made within the corresponding document.

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.

fn encode_diff<E: Encoder>(&self, state_vector: &StateVector, encoder: &mut E)

Encodes the difference between remove peer state given its state_vector and the state of a current local peer

fn encode_diff_v1(&self, state_vector: &StateVector) -> Vec<u8>

fn encode_state_as_update<E: Encoder>(&self, sv: &StateVector, encoder: &mut E)

fn encode_state_as_update_v1(&self, sv: &StateVector) -> Vec<u8>

fn encode_state_as_update_v2(&self, sv: &StateVector) -> Vec<u8>

fn root_refs(&self) -> RootRefs<'_>

Returns an iterator over top level (root) shared types available in current Doc.

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

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

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

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

fn get_text(&self, name: &str) -> Option<TextRef>

Returns a TextRef data structure stored under a given name. Text structures are used for collaborative text editing: they expose operations to append and remove chunks of text, which are free to execute concurrently by multiple peers over remote boundaries.

fn get_array(&self, name: &str) -> Option<ArrayRef>

Returns an ArrayRef data structure stored under a given name. Array structures are used for storing a sequences of elements in ordered manner, positioning given element accordingly to its index.

fn get_map(&self, name: &str) -> Option<MapRef>

Returns a MapRef data structure stored under a given name. Maps are used to store key-value pairs associated together. These values can be primitive data (similar but not limited to a JavaScript Object Notation) as well as other shared types (Yrs maps, arrays, text structures etc.), enabling to construct a complex recursive tree structures.

fn get_xml_fragment(&self, name: &str) -> Option<XmlFragmentRef>

Returns a XmlFragmentRef data structure stored under a given name. XML elements represent nodes of XML document. They can contain attributes (key-value pairs, both of string type) as well as other nested XML elements or text values, which are stored in their insertion order.

fn get_xml_element(&self, name: &str) -> Option<XmlElementRef>

Returns a XmlElementRef data structure stored under a given name. XML elements represent nodes of XML document. They can contain attributes (key-value pairs, both of string type) as well as other nested XML elements or text values, which are stored in their insertion order.

fn get_xml_text(&self, name: &str) -> Option<XmlTextRef>

Returns a XmlTextRef data structure stored under a given name. Text structures are used for collaborative text editing: they expose operations to append and remove chunks of text, which are free to execute concurrently by multiple peers over remote boundaries.

impl<'doc> WriteTxn for TransactionMut<'doc>

fn store_mut(&mut self) -> &mut Store

fn subdocs_mut(&mut self) -> &mut Subdocs