Enum BranchID 

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

An unique logical identifier of a shared collection. Can be shared across document boundaries to reference to the same logical entity across different replicas of a document.

Variants

Nested(ID)

Root(Arc<str>)

Implementations

impl BranchID

pub fn get_root<T, K>(txn: &T, name: K) -> Option<BranchPtr>

where T: ReadTxn, K: Borrow<str>,

pub fn get_nested<T>(txn: &T, id: &ID) -> Option<BranchPtr>

where T: ReadTxn,

pub fn get_branch<T>(&self, txn: &T) -> Option<BranchPtr>

where T: ReadTxn,

Trait Implementations

impl Clone for BranchID

fn clone(&self) -> BranchID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BranchID

fn deserialize<__D>( __deserializer: __D, ) -> Result<BranchID, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> From<BranchID> for Hook<S>

fn from(id: BranchID) -> Hook<S>

Converts to this type from the input type.

impl Hash for BranchID

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

where __H: Hasher,

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<S> Into<BranchID> for Hook<S>

fn into(self) -> BranchID

Converts this type into the (usually inferred) input type.

impl<S> Into<BranchID> for Nested<S>

fn into(self) -> BranchID

Converts this type into the (usually inferred) input type.

impl<S> Into<BranchID> for Root<S>

fn into(self) -> BranchID

Converts this type into the (usually inferred) input type.

impl Ord for BranchID

fn cmp(&self, other: &BranchID) -> 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,

Restrict a value to a certain interval.

impl PartialEq for BranchID

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

fn partial_cmp(&self, other: &BranchID) -> 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 BranchID

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BranchID

impl StructuralPartialEq for BranchID