Struct Immutable 

pub struct Immutable<T> { /* private fields */ }

A write-once register that retains unequal concurrent initial values.

Implementations

impl<T> Immutable<T>

pub const fn new() -> Self

Constructs an unset immutable value.

pub fn get(&self) -> Result<Option<&T>, CrdtError>

Reads the value, returning a typed error for concurrent initial values.

pub fn values(&self) -> impl Iterator<Item = &T>

Iterates over all causally concurrent initial values in dot order.

impl<T: Clone + Eq> Immutable<T>

pub fn set( &mut self, value: T, dot: Dot, context: VersionVector, ) -> Result<(), CrdtError>

Sets an initial value, rejecting causal reassignment.

pub fn merge(&mut self, other: &Self) -> Result<(), CrdtError>

Deterministically combines another replica’s state.

pub fn canonicalize_for_commit( &self, author: AuthorId, sequence: u64, context: &VersionVector, next_operation: &mut u32, ) -> Result<Self, CrdtError>

Reissues every concurrent initial value under commit-owned dots.

Trait Implementations

impl<T: Clone> Clone for Immutable<T>

fn clone(&self) -> Immutable<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Immutable<T>

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

Formats the value using the given formatter.

impl<'bytes, Ctx, T: Decode<'bytes, Ctx>> Decode<'bytes, Ctx> for Immutable<T>

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx, ) -> Result<Immutable<T>, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl<T> Default for Immutable<T>

fn default() -> Self

Returns the “default value” for a type.

impl<Ctx, T: Encode<Ctx>> Encode<Ctx> for Immutable<T>

fn encode<__W777>( &self, __e777: &mut Encoder<__W777>, __ctx777: &mut Ctx, ) -> Result<(), Error<__W777::Error>>

where __W777: Write,

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl<T> FieldState for Immutable<T>

where T: Clone + Eq + Encode<()> + for<'bytes> Decode<'bytes, ()>,

const CRDT_KIND: CrdtKind = CrdtKind::Immutable

The deterministic merge strategy.

type Value = T

The application value carried by this field strategy.

fn encode_state(&self) -> Result<Vec<u8>, RecordError>

Encodes complete causal field state.

fn decode_state(bytes: &[u8]) -> Result<Self, RecordError>

Strictly decodes complete causal field state.

fn visible_values(&self) -> Result<Vec<Vec<u8>>, RecordError>

Encodes each currently visible application value for filtering and indexes.

fn merge_state(&mut self, other: &Self) -> Result<(), RecordError>

Deterministically merges complete causal state from another replica.

fn canonicalize_for_commit( &self, author: AuthorId, sequence: u64, context: &VersionVector, next_operation: &mut u32, ) -> Result<Self, RecordError>

Reissues all causal identities from one authenticated commit envelope.

fn value_type_name() -> &'static str

Stable Rust logical value type used in schema compatibility checks.

impl<T: Clone + Eq> Merge for Immutable<T>

fn merge(&mut self, other: &Self) -> Result<(), CrdtError>

Merges other into this value.

impl<T: PartialEq> PartialEq for Immutable<T>

fn eq(&self, other: &Immutable<T>) -> bool

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

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<T: Eq> Eq for Immutable<T>

impl<T> StructuralPartialEq for Immutable<T>