Struct yrs::StateVector

pub struct StateVector(_);

State vector is a compact representation of all known blocks inserted and integrated into a given document. This descriptor can be serialized and used to determine a difference between seen and unseen inserts of two replicas of the same document, potentially existing in different processes.

Another popular name for the concept represented by state vector is Version Vector.

Implementations

impl StateVector

pub fn is_empty(&self) -> bool

Checks if current state vector contains any data.

pub fn len(&self) -> usize

Returns a number of unique clients observed by a document, current state vector corresponds to.

pub fn contains(&self, id: &ID) -> bool

Checks if current state vector includes given block identifier. Blocks, which identifiers can be found in a state vectors don’t need to be encoded as part of an update, because they were already observed by their remote peer, current state vector refers to.

pub fn get(&self, client_id: &u64) -> u32

Get the latest clock sequence number value for a given client_id as observed from the perspective of a current state vector.

pub fn inc_by(&mut self, client: u64, delta: u32)

Updates a state vector observed clock sequence number for a given client by incrementing it by a given delta.

pub fn set_min(&mut self, client: u64, clock: u32)

Updates a state vector observed clock sequence number for a given client by setting it to a minimum value between an already present one and the provided clock. In case if state vector didn’t contain any value for that client, a clock value will be used.

pub fn set_max(&mut self, client: u64, clock: u32)

Updates a state vector observed clock sequence number for a given client by setting it to a maximum value between an already present one and the provided clock. In case if state vector didn’t contain any value for that client, a clock value will be used.

pub fn iter(&self) -> Iter<'_, u64, u32>

Returns an iterator which enables to traverse over all clients and their known clock values described by a current state vector.

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

Merges another state vector into a current one. Since vector’s clock values can only be incremented, whenever a conflict between two states happen (both state vectors have different clock values for the same client entry), a highest of these to is considered to be the most up-to-date.

Trait Implementations

impl Clone for StateVector

fn clone(&self) -> StateVector

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StateVector

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

Formats the value using the given formatter.

impl Decode for StateVector

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

fn decode_v1(data: &[u8]) -> Self

Helper function for decoding 1st version of lib0 encoding.

impl Default for StateVector

fn default() -> StateVector

Returns the “default value” for a type.

impl Encode for StateVector

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

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

Helper function for encoding 1st version of lib0 encoding.

impl PartialEq<StateVector> for StateVector

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

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

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

This method tests for !=.

impl Eq for StateVector

impl StructuralEq for StateVector

impl StructuralPartialEq for StateVector