Struct 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 const EMPTY_V1: &'static [u8]

Binary containing an empty update, serialized via lib0 version 1 encoder.

pub const EMPTY_V2: &'static [u8]

Binary containing an empty update, serialized via lib0 version 2 encoder.

pub fn new() -> Update

pub fn is_empty(&self) -> bool

Check if current update is empty.

pub fn extends(&self, state_vector: &StateVector) -> bool

Check if current update has changes that add new information to a document with given state.

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 state_vector_lower(&self) -> StateVector

Returns a state vector representing a lower bound of items inserted by this update, grouped by their respective clients.

pub fn insertions(&self, include_deleted: bool) -> IdSet

Returns an insertion set associated with current update. It contains ids of all blocks inserted by this update. If include_deleted flag is set, result will include GC’ed blocks and ones that were inserted but softly deleted.

pub fn delete_set(&self) -> &DeleteSet

Returns a delete set associated with current update.

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

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

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<(), Error>

Formats the value using the given formatter.

impl Decode for Update

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

where D: Decoder,

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<(), Error>

Formats the value using the given formatter.

impl Encode for Update

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

where E: Encoder,

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 2nd version of lib0 encoding.

impl PartialEq for Update

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Update