Struct yrs::branch::Branch

pub struct Branch {
    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

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: TypeRef) -> Arc<Self>

pub fn is_deleted(&self) -> bool

pub fn id(&self) -> BranchID

pub fn as_subdoc(&self) -> Option<Doc>

pub fn type_ref(&self) -> &TypeRef

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) -> u32

pub fn observe<F>(&mut self, f: F) -> Subscription

where F: Fn(&TransactionMut<'_>, &Event) + 'static,

pub fn observe_deep<F>(&self, f: F) -> Subscription

where F: Fn(&TransactionMut<'_>, &Events) + 'static,

Trait Implementations

impl AsMut<Branch> for BranchPtr

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

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

impl AsRef<Branch> for ArrayRef

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for BranchPtr

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for MapRef

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for TextRef

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for XmlElementRef

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for XmlFragmentRef

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for XmlHookRef

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for XmlNode

fn as_ref(&self) -> &Branch

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

impl AsRef<Branch> for XmlTextRef

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 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Branch