Struct crdts::merkle_reg::MerkleReg

pub struct MerkleReg<T> { /* fields omitted */ }

The MerkleReg is a Register CRDT that uses the Merkle DAG structure to track the current value(s) held by this register. The leaves of the Merkle DAG are the current values.

Implementations

impl<T> MerkleReg<T>

pub fn new() -> Self

Return a new instance of the MerkleReg

pub fn read(&self) -> Content<'_, T>

Read the current values held by the register

pub fn write(&self, value: T, parents: BTreeSet<Hash>) -> Node<T>

Write the given value on top of the given parents.

pub fn node(&self, hash: Hash) -> Option<&Node<T>>

Retrieve a node in the Merkle DAG by it’s hash.

Traverse the history the register by pair this method with the parents of the nodes retrieved in Content::nodes().

pub fn parents(&self, hash: Hash) -> Content<'_, T>

Returns the parents of a node

pub fn children(&self, hash: Hash) -> Content<'_, T>

Returns the children of a node

pub fn num_nodes(&self) -> usize

Returns the number of nodes who are visible, i.e. their parents have been seen.

pub fn num_orphans(&self) -> usize

Returns the number of nodes who are not visible due to missing parents.

Trait Implementations

impl<T: Arbitrary + Sha3Hash> Arbitrary for MerkleReg<T>

fn arbitrary<G: Gen>(g: &mut G) -> Self

pub fn shrink(&self) -> Box<dyn Iterator<Item = Self> + 'static, Global>

impl<T: Clone> Clone for MerkleReg<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Sha3Hash> CmRDT for MerkleReg<T>

type Op = Node<T>

Op defines a mutation to the CRDT. As long as Op’s from one actor are replayed in exactly the same order they were generated by that actor, the CRDT will converge. In other words, we must have a total ordering on each actors operations, while requiring only a partial order over all ops. E.g.

type Validation = ValidationError

The validation error returned by validate_op.

fn validate_op(&self, op: &Self::Op) -> Result<(), Self::Validation>

Some CRDT’s have stricter requirements on how they must be used. To avoid violating these requirements, CRDT’s provide an interface to optionally validate op’s before they are applied.

fn apply(&mut self, node: Self::Op)

Apply an Op to the CRDT

impl<T: Sha3Hash> CvRDT for MerkleReg<T>

type Validation = Infallible

The validation error returned by validate_merge.

fn validate_merge(&self, _: &Self) -> Result<(), Self::Validation>

Some CRDT’s have stricter requirements on how they must be used. To avoid violating these requirements, CRDT’s provide an interface to optionally validate merge compatibility before attempting to merge.

fn merge(&mut self, other: Self)

Merge the given CRDT into the current CRDT.

impl<T: Debug> Debug for MerkleReg<T>

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

Formats the value using the given formatter.

impl<T> Default for MerkleReg<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for MerkleReg<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for MerkleReg<T>

impl<T: Hash> Hash for MerkleReg<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for MerkleReg<T>

fn cmp(&self, other: &MerkleReg<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<MerkleReg<T>> for MerkleReg<T>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MerkleReg<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<MerkleReg<T>> for MerkleReg<T>

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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<T> Serialize for MerkleReg<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T> StructuralEq for MerkleReg<T>

impl<T> StructuralPartialEq for MerkleReg<T>