Struct yrs::types::BranchRef

pub struct BranchRef(_);

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.

Implementations

impl BranchRef

pub fn new(inner: Branch) -> Self

pub fn borrow(&self) -> Ref<'_, Branch>

Returns an immutable ref wrapper to an underlying Branch. This method will panic, if current branch was already mutably borrowed.

pub fn borrow_mut(&self) -> RefMut<'_, Branch>

Returns a mutable ref wrapper to an underlying Branch. This method will panic, if current branch was already borrowed (either mutably or immutably) somewhere else.

pub fn try_borrow_mut(&self) -> Result<RefMut<'_, Branch>, BorrowMutError>

Returns a result, which may either be a mutable ref wrapper to an underlying Branch, or an error in case when this branch was already borrowed (either mutably or immutably) somewhere else.

pub fn into_value(self, _txn: &Transaction) -> 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.

Trait Implementations

impl AsRef<Branch> for BranchRef

fn as_ref<'a>(&'a self) -> &'a Branch

Performs the conversion.

impl Clone for BranchRef

fn clone(&self) -> BranchRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BranchRef

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

Formats the value using the given formatter.

impl From<BranchRef> for Array

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl From<BranchRef> for Map

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl From<BranchRef> for Text

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl From<BranchRef> for Xml

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl From<BranchRef> for XmlElement

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl From<BranchRef> for XmlHook

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl From<BranchRef> for XmlText

fn from(inner: BranchRef) -> Self

Performs the conversion.

impl PartialEq<BranchRef> for BranchRef

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 BranchRef