Struct yrs::Update

pub struct Update { /* private fields */ }

Update type which contains an information about all decoded blocks which are incoming from a remote peer. Since these blocks are not yet integrated into current document’s block store, they still may require repairing before doing so as they don’t contain full data about their relations.

Update is conceptually similar to a block store itself, however the work patters are different.

Implementations

impl Update

pub fn new() -> Self

pub fn state_vector(&self) -> StateVector

Returns a state vector representing an upper bound of client clocks included by blocks stored in current update.

pub fn merge(&mut self, other: Self)

Merges another update into current one. Their blocks are deduplicated and reordered.

pub fn integrate(
    self,
    txn: &mut Transaction
) -> (Option<PendingUpdate>, Option<Update>)

Integrates current update into a block store referenced by a given transaction. If entire integration process was successful a None value is returned. Otherwise a pending update object is returned which contains blocks that couldn’t be integrated, most likely because there were missing blocks that are used as a dependencies of other blocks contained in this update.

pub fn merge_updates<T>(block_stores: T) -> Update where
    T: IntoIterator<Item = Update>, 

Trait Implementations

impl Debug for Update

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

Formats the value using the given formatter.

impl Decode for Update

fn decode<D: Decoder>(decoder: &mut D) -> Result<Self, Error>

fn decode_v1(data: &[u8]) -> Result<Self, Error>

Helper function for decoding 1st version of lib0 encoding.

fn decode_v2(data: &[u8]) -> Result<Self, Error>

Helper function for decoding 2nd version of lib0 encoding.

impl Default for Update

fn default() -> Update

Returns the “default value” for a type.

impl Display for Update

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

Formats the value using the given formatter.

impl Encode for Update

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

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.

impl PartialEq<Update> for Update

fn eq(&self, other: &Update) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Update) -> bool

This method tests for !=.

impl StructuralPartialEq for Update