Struct loro_common::TreeID

pub struct TreeID {
    pub peer: PeerID,
    pub counter: Counter,
}

Each node of movable tree has a unique TreeID generated by Loro.

To further represent the metadata (a MapContainer) associated with each node, we also use TreeID as ID portion of ContainerID. This not only allows for convenient association of metadata with each node, but also ensures the uniqueness of the MapContainer.

Special ID:

• DELETED_TREE_ROOT: the root of all deleted nodes. To get it by TreeID::delete_root()

Fields

peer: PeerID

counter: Counter

Implementations

impl TreeID

pub fn new(peer: PeerID, counter: Counter) -> Self

pub const fn delete_root() -> Self

return DELETED_TREE_ROOT

pub fn is_deleted_root(target: &TreeID) -> bool

return true if the TreeID is deleted root

pub fn from_id(id: ID) -> Self

pub fn id(&self) -> ID

pub fn associated_meta_container(&self) -> ContainerID

Trait Implementations

impl Clone for TreeID

fn clone(&self) -> TreeID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TreeID

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TreeID

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

Formats the value using the given formatter.

impl Hash for TreeID

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 TreeID

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

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for TreeID

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for TreeID

type Error = LoroError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for TreeID

impl Eq for TreeID

impl StructuralPartialEq for TreeID