Struct yrs::types::BranchPtr

#[repr(transparent)]
pub struct BranchPtr(_);

A wrapper around Branch cell, supplied with a bunch of convenience methods to operate on both map-like and array-like contents of a Branch.

Methods from Deref<Target = Branch>

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 Clone for BranchPtr

fn clone(&self) -> BranchPtr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BranchPtr

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

Formats the value using the given formatter.

impl Deref for BranchPtr

type Target = Branch

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for BranchPtr

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a> From<&'a Box<Branch, Global>> for BranchPtr

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> From<&'a mut Box<Branch, Global>> for BranchPtr

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

Converts to this type from the input type.

impl From<BranchPtr> for Array

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for Map

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for Text

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for Xml

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for XmlElement

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for XmlHook

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for XmlText

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl Hash for BranchPtr

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, 

Feeds a slice of this type into the given Hasher.

impl Into<Value> for BranchPtr

fn into(self) -> Value

Converts current branch data into a Value. It uses a type ref information to resolve, which value variant is a correct one for this branch. Since branch represent only complex types Value::Any will never be returned from this method.

impl PartialEq<BranchPtr> for BranchPtr

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 Copy for BranchPtr

impl Eq for BranchPtr