Struct yrs::DeleteSet

pub struct DeleteSet(_);

DeleteSet contains information about all blocks (described by clock ranges) that have been subjected to delete process.

Implementations

impl DeleteSet

pub fn new() -> Self

Creates a new empty delete set instance.

pub fn insert(&mut self, id: ID, len: u32)

Inserts an information about delete block (identified by id and having a specified length) inside of a current delete set.

pub fn len(&self) -> usize

Returns number of clients stored;

pub fn is_empty(&self) -> bool

Checks if delete set contains any clock ranges.

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

Checks if given block id is considered deleted from the perspective of current delete set.

pub fn iter(&self) -> Iter<'_, ClientID, IdRange>

Returns an iterator over all client-range pairs registered in this delete set.

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

Merges another delete set into a current one, combining their information about deleted clock ranges.

pub fn squash(&mut self)

Squashes the contents of a current delete set. This operation means, that in case when delete set contains any overlapping ranges within, they will be squashed together to optimize the space and make future encoding more compact.

pub fn range(&self, client_id: &ClientID) -> Option<&IdRange>

Trait Implementations

impl Clone for DeleteSet

fn clone(&self) -> DeleteSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteSet

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

Formats the value using the given formatter.

impl Decode for DeleteSet

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 DeleteSet

fn default() -> Self

Returns the “default value” for a type.

impl Display for DeleteSet

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

Formats the value using the given formatter.

impl Encode for DeleteSet

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<DeleteSet> for DeleteSet

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

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

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

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

impl Eq for DeleteSet

impl StructuralEq for DeleteSet

impl StructuralPartialEq for DeleteSet