Struct yrs::types::Branch

pub struct Branch {
    pub name: Option<Rc<str>>,
    pub block_len: u32,
    pub content_len: u32,
    /* private fields */
}

Branch describes a content of a complex Yrs data structures, such as arrays or maps.

Fields

name: Option<Rc<str>>

A tag name identifier, used only by XmlElement.

block_len: u32

A length of an indexed sequence component of a current branch node. Map component elements are computed on demand.

content_len: u32

Implementations

impl Branch

pub fn new(type_ref: TypeRefs, name: Option<Rc<str>>) -> Box<Self>

pub fn type_ref(&self) -> TypeRefs

Returns an identifier of an underlying complex data type (eg. is it an Array or a Map).

pub fn len(&self) -> u32

Returns a length of an indexed sequence component of a current branch node. Map component elements are computed on demand.

pub fn content_len(&self, _: &Transaction) -> u32

pub fn observe_deep<F>(&mut self, f: F) -> Subscription<Events> where
    F: Fn(&Transaction, &Events) + 'static, 

pub fn unobserve_deep(&mut self, subscription_id: SubscriptionId)

Trait Implementations

impl AsMut<Branch> for Array

fn as_mut(&mut self) -> &mut Branch

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Branch> for Map

fn as_mut(&mut self) -> &mut Branch

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Branch> for Text

fn as_mut(&mut self) -> &mut Branch

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Branch> for XmlElement

fn as_mut(&mut self) -> &mut Branch

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Branch> for XmlFragment

fn as_mut(&mut self) -> &mut Branch

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Branch> for XmlText

fn as_mut(&mut self) -> &mut Branch

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Branch> for Array

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Branch> for Map

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Branch> for Text

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Branch> for XmlElement

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Branch> for XmlFragment

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Branch> for XmlText

fn as_ref(&self) -> &Branch

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Branch

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

Formats the value using the given formatter.

impl Display for Branch

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

Formats the value using the given formatter.

impl<'a> From<&'a Branch> for BranchPtr

fn from(branch: &'a Branch) -> Self

Converts to this type from the input type.

impl PartialEq<Branch> for Branch

fn eq(&self, other: &Self) -> 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 !=.

impl Eq for Branch