Struct yrs::Origin

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

A binary marker that can be assigned to a read-write transaction upon creation via Transact::try_transact_mut_with/Transact::transact_mut_with. It can be used to classify transaction updates within a specific context, which exists for the duration of a transaction (it’s not persisted in the document store itself), i.e. you can use unique document client identifiers to differentiate updates incoming from remote nodes from those performed locally.

Trait Implementations

impl AsRef<[u8]> for Origin

fn as_ref(&self) -> &[u8]

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

impl Clone for Origin

fn clone(&self) -> Origin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Origin

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

Formats the value using the given formatter.

impl Display for Origin

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for Origin

fn from(slice: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Origin

fn from(v: &'a str) -> Self

Converts to this type from the input type.

impl<'a, T> From<Pin<&'a T>> for Origin

fn from(p: Pin<&T>) -> Self

Converts to this type from the input type.

impl From<String> for Origin

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<i128> for Origin

fn from(v: i128) -> Origin

Converts to this type from the input type.

impl From<i16> for Origin

fn from(v: i16) -> Origin

Converts to this type from the input type.

impl From<i32> for Origin

fn from(v: i32) -> Origin

Converts to this type from the input type.

impl From<i64> for Origin

fn from(v: i64) -> Origin

Converts to this type from the input type.

impl From<i8> for Origin

fn from(v: i8) -> Origin

Converts to this type from the input type.

impl From<isize> for Origin

fn from(v: isize) -> Origin

Converts to this type from the input type.

impl From<u128> for Origin

fn from(v: u128) -> Origin

Converts to this type from the input type.

impl From<u16> for Origin

fn from(v: u16) -> Origin

Converts to this type from the input type.

impl From<u32> for Origin

fn from(v: u32) -> Origin

Converts to this type from the input type.

impl From<u64> for Origin

fn from(v: u64) -> Origin

Converts to this type from the input type.

impl From<u8> for Origin

fn from(v: u8) -> Origin

Converts to this type from the input type.

impl From<usize> for Origin

fn from(v: usize) -> Origin

Converts to this type from the input type.

impl Hash for Origin

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 Ord for Origin

fn cmp(&self, other: &Origin) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Origin

fn eq(&self, other: &Origin) -> 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 PartialOrd for Origin

fn partial_cmp(&self, other: &Origin) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Origin

impl StructuralPartialEq for Origin