Struct Root 

#[repr(transparent)]
pub struct Root<S> {
    pub name: Arc<str>,
    /* private fields */
}

A logical reference to a root-level shared collection. It can be shared across different documents to reference the same logical type.

Example

use yrs::{Doc, RootRef, SharedRef, TextRef, Transact};

let root = TextRef::root("hello");

let doc1 = Doc::new();
let txt1 = root.get_or_create(&mut doc1.transact_mut());

let doc2 = Doc::new();
let txt2 = root.get_or_create(&mut doc2.transact_mut());

// instances of TextRef point to different heap objects
assert_ne!(&txt1 as *const _, &txt2 as *const _);

// logical descriptors of both TextRef are the same as they refer to the
// same logical entity
assert_eq!(txt1.hook(), txt2.hook());

Fields

name: Arc<str>

Unique identifier of root-level shared collection.

Implementations

impl<S: RootRef> Root<S>

pub fn new<N: Into<Arc<str>>>(name: N) -> Self

Creates a new logical reference for a root-level shared collection of a given name and type. Returned value can be used to resolve instances of root-level types by calling Root::get or Root::get_or_create.

pub fn get_or_create<T: WriteTxn>(&self, txn: &mut T) -> S

Returns a reference to a shared root-level collection current Root represents, or creates it if it wasn’t instantiated before.

impl<S: SharedRef> Root<S>

pub fn get<T: ReadTxn>(&self, txn: &T) -> Option<S>

Returns a reference to a shared collection current Root represents, or returns None if that collection hasn’t been instantiated yet.

Trait Implementations

impl<S: Clone> Clone for Root<S>

fn clone(&self) -> Root<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Root<S>

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

Formats the value using the given formatter.

impl<S: Eq> Eq for Root<S>

impl<S> From<Root<S>> for Hook<S>

fn from(root: Root<S>) -> Self

Converts to this type from the input type.

impl<S: Hash> Hash for Root<S>

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

fn into(self) -> BranchID

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

impl<S: Ord> Ord for Root<S>

fn cmp(&self, other: &Root<S>) -> 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<S: PartialEq> PartialEq for Root<S>

fn eq(&self, other: &Root<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S: PartialOrd> PartialOrd for Root<S>

fn partial_cmp(&self, other: &Root<S>) -> 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<S: PartialEq> StructuralPartialEq for Root<S>