Enum yrs::IndexScope

pub enum IndexScope {
    Relative(ID),
    Nested(ID),
    Root(Arc<str>),
}

Struct describing context in which StickyIndex is placed. For items pointing inside of the shared typed sequence it’s always [StickyIndex::Relative] which refers to a block ID found under corresponding position.

In case when a containing collection is empty, there’s a no block ID that can be used as point of reference. In that case we store either a parent collection root type name or its branch ID instead (if collection is nested into another).

Using IDs guarantees that corresponding StickyIndex doesn’t shift under incoming concurrent updates.

Variants

Relative(ID)

StickyIndex is relative to a given block ID. This happens whenever we set StickyIndex somewhere inside the non-empty shared collection.

Nested(ID)

If a containing collection is a nested y-type, which is empty, this case allows us to identify that nested type.

Root(Arc<str>)

If a containing collection is a root-level y-type, which is empty, this case allows us to identify that nested type.

Implementations

impl IndexScope

pub fn from_branch(branch: BranchPtr) -> Self

Trait Implementations

impl Clone for IndexScope

fn clone(&self) -> IndexScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexScope

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

Formats the value using the given formatter.

impl Decode for IndexScope

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<'de> Deserialize<'de> for IndexScope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for IndexScope

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

impl Hash for IndexScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IndexScope

fn cmp(&self, other: &IndexScope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for IndexScope

fn eq(&self, other: &IndexScope) -> 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 PartialOrd for IndexScope

fn partial_cmp(&self, other: &IndexScope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for IndexScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for IndexScope

impl StructuralPartialEq for IndexScope