Struct yrs::branch::BranchPtr

pub struct BranchPtr(/* private fields */);

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

fn as_ref(&self) -> &Branch

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

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 Arc<Branch>> for BranchPtr

fn from(branch: &'a Arc<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 Arc<Branch>> for BranchPtr

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

Converts to this type from the input type.

impl From<BranchPtr> for ArrayRef

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for MapRef

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for TextRef

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for XmlElementRef

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for XmlFragmentRef

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for XmlHookRef

fn from(inner: BranchPtr) -> Self

Converts to this type from the input type.

impl From<BranchPtr> for XmlTextRef

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<Origin> for BranchPtr

fn into(self) -> Origin

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

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

impl TryFrom<BranchPtr> for XmlNode

type Error = BranchPtr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for BranchPtr

impl Eq for BranchPtr