Struct Digested 

pub struct Digested<T: Digestible> { /* private fields */ }

A shared value paired with its Digest.

Digested::compute hashes the value as a job on a Strategy, and Digested::precomputed pairs it with a digest a local source already computed from this exact value. Holders read the digest for free and never choose a strategy. The value must not change anything its digest covers while a carrier refers to it.

Cloning shares the value. Two values are equal when their digests are equal, which the Digestible contract makes equivalent to the values being equal. The value encodes as the inner value does, and there is no decoding. A decoded value is paired with its digest by one of the constructors.

Implementations

impl<T: Digestible> Digested<T>

pub fn compute( inner: impl Into<Arc<T>>, strategy: &impl Strategy, ) -> impl Future<Output = Self> + Send + 'static

where T: EncodeSize,

Computes the digest of inner as a job on strategy.

pub fn precomputed(inner: impl Into<Arc<T>>, digest: T::Digest) -> Self

Pairs inner with a digest already computed from this exact value.

digest must come from a local source bound to inner, such as the key the value was stored under, a commitment checked against its bytes, or an earlier Self::compute. It says nothing about whether the value is valid or certified.

pub fn inner(&self) -> &T

Returns a reference to the value.

pub fn inner_shared(&self) -> Arc<T>

Returns a shared reference to the value.

Trait Implementations

impl<T: Digestible> Clone for Digested<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Digestible + Debug> Debug for Digested<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

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

Formats the value using the given formatter.

impl<T: Digestible> Digestible for Digested<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

type Digest = <T as Digestible>::Digest

The type of digest produced by this object.

fn digest(&self) -> Self::Digest

Returns a unique representation of the object as a Digest.

fn digest_across(&self, _strategy: &impl Strategy) -> Self::Digest

Returns the object’s digest, splitting any work in computing it across strategy.

impl<T: Digestible + EncodeSize> EncodeSize for Digested<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the fixed working buffer for inline writes, so it must not be less than the bytes written inline. Override alongside Write::write_bufs for types where large byte fields go via push, or the working buffer will over-allocate.

impl<T: Digestible> Eq for Digested<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

impl<T: Digestible> From<Digested<T>> for Arc<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

fn from(digested: Digested<T>) -> Self

Converts to this type from the input type.

impl<T: Digestible> PartialEq for Digested<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

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

Equality operator ==.

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

Inequality operator !=.

impl<T: Digestible + Write> Write for Digested<T>

Available on neither commonware_stability_DELTA nor commonware_stability_EPSILON nor commonware_stability_GAMMA nor commonware_stability_RESERVED.

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing byte chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.