BranchPtr

eidetica::y_crdt::branch

Struct BranchPtr

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

Expand description

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) -> Arc<dyn Drop>
where F: Fn(&TransactionMut<'_>, &Event) + 'static,

pub fn observe_with<F>(&mut self, key: Origin, f: F)
where F: Fn(&TransactionMut<'_>, &Event) + 'static,

pub fn unobserve(&mut self, key: &Origin) -> bool

pub fn observe_deep<F>(&self, f: F) -> Arc<dyn Drop>
where F: Fn(&TransactionMut<'_>, &Events<'_>) + 'static,

pub fn observe_deep_with<F>(&self, key: Origin, f: F)
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 duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for BranchPtr

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

Formats the value using the given formatter. Read more

impl Deref for BranchPtr

type Target = Branch

The resulting type after dereferencing.

fn deref(&self) -> &<BranchPtr as Deref>::Target

Dereferences the value.

impl DerefMut for BranchPtr

fn deref_mut(&mut self) -> &mut <BranchPtr as Deref>::Target

Mutably dereferences the value.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<BranchPtr> for ArrayRef

fn from(inner: BranchPtr) -> ArrayRef

Converts to this type from the input type.

impl From<BranchPtr> for MapRef

fn from(inner: BranchPtr) -> MapRef

Converts to this type from the input type.

impl From<BranchPtr> for TextRef

fn from(inner: BranchPtr) -> TextRef

Converts to this type from the input type.

impl From<BranchPtr> for XmlElementRef

fn from(inner: BranchPtr) -> XmlElementRef

Converts to this type from the input type.

impl From<BranchPtr> for XmlFragmentRef

fn from(inner: BranchPtr) -> XmlFragmentRef

Converts to this type from the input type.

impl From<BranchPtr> for XmlHookRef

fn from(inner: BranchPtr) -> XmlHookRef

Converts to this type from the input type.

impl From<BranchPtr> for XmlTextRef

fn from(inner: BranchPtr) -> XmlTextRef

Converts to this type from the input type.

impl Hash for BranchPtr

fn hash<H>(&self, state: &mut H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl Into<Origin> for BranchPtr

fn into(self) -> Origin

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

impl Into<Out> for BranchPtr

fn into(self) -> Out

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

impl Into<TypePtr> for BranchPtr

fn into(self) -> TypePtr

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

impl PartialEq for BranchPtr

fn eq(&self, other: &BranchPtr) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<BranchPtr> for XmlOut

type Error = BranchPtr

The type returned in the event of a conversion error.

fn try_from( value: BranchPtr, ) -> Result<XmlOut, <XmlOut as TryFrom<BranchPtr>>::Error>

Performs the conversion.

impl TryFrom<ItemPtr> for BranchPtr

type Error = ItemPtr

The type returned in the event of a conversion error.

fn try_from( value: ItemPtr, ) -> Result<BranchPtr, <BranchPtr as TryFrom<ItemPtr>>::Error>

Performs the conversion.

impl Copy for BranchPtr

impl Eq for BranchPtr

impl Send for BranchPtr

impl Sync for BranchPtr

Auto Trait Implementations§

impl Freeze for BranchPtr

impl !RefUnwindSafe for BranchPtr

impl Unpin for BranchPtr

impl !UnwindSafe for BranchPtr

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more