Struct Compact

pub struct Compact<H, T> {
    pub tuple: T,
    /* private fields */
}

A composition of multiple leaf elements with compact form representation.

When composing together multiple LeafDataProviders you will end up with a tuple of LeafData that each element provides.

However this will cause the leaves to have significant size, while for some use cases it will be enough to prove only one element of the tuple. That’s the rationale for Compact struct. We wrap each element of the tuple into DataOrHash and each tuple element is hashed first before constructing the final hash of the entire tuple. This allows you to replace tuple elements you don’t care about with their hashes.

Fields

tuple: T

Internal tuple representation.

Implementations

impl<H, T> Compact<H, T>

pub fn new(tuple: T) -> Self

Create a new Compact wrapper for a tuple.

Trait Implementations

impl<H: Clone, T: Clone> Clone for Compact<H, T>

fn clone(&self) -> Compact<H, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H, T> Debug for Compact<H, T>

where H: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<H, T: Decode> Decode for Compact<H, T>

fn decode<I: Input>(value: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<H, T> Deref for Compact<H, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<H, A> FullLeaf for Compact<H, (DataOrHash<H, A>,)>

where H: Hash, A: FullLeaf,

FullLeaf implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F, compact: bool) -> R

Encode the leaf either in its full or compact form.

impl<H, A, B> FullLeaf for Compact<H, (DataOrHash<H, A>, DataOrHash<H, B>)>

where H: Hash, A: FullLeaf, B: FullLeaf,

FullLeaf implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F, compact: bool) -> R

Encode the leaf either in its full or compact form.

impl<H, A, B, C> FullLeaf for Compact<H, (DataOrHash<H, A>, DataOrHash<H, B>, DataOrHash<H, C>)>

where H: Hash, A: FullLeaf, B: FullLeaf, C: FullLeaf,

FullLeaf implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F, compact: bool) -> R

Encode the leaf either in its full or compact form.

impl<H, A, B, C, D> FullLeaf for Compact<H, (DataOrHash<H, A>, DataOrHash<H, B>, DataOrHash<H, C>, DataOrHash<H, D>)>

where H: Hash, A: FullLeaf, B: FullLeaf, C: FullLeaf, D: FullLeaf,

FullLeaf implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F, compact: bool) -> R

Encode the leaf either in its full or compact form.

impl<H, A, B, C, D, E> FullLeaf for Compact<H, (DataOrHash<H, A>, DataOrHash<H, B>, DataOrHash<H, C>, DataOrHash<H, D>, DataOrHash<H, E>)>

where H: Hash, A: FullLeaf, B: FullLeaf, C: FullLeaf, D: FullLeaf, E: FullLeaf,

FullLeaf implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F, compact: bool) -> R

Encode the leaf either in its full or compact form.

impl<H, A> LeafDataProvider for Compact<H, (A,)>

where H: Hash, A: LeafDataProvider,

LeafDataProvider implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

This provides a compact-form encoding for tuples wrapped in Compact.

type LeafData = Compact<H, (DataOrHash<H, <A as LeafDataProvider>::LeafData>,)>

A type that should end up in the leaf of MMR.

fn leaf_data() -> Self::LeafData

The method to return leaf data that should be placed in the leaf node appended MMR at this block.

impl<H, A, B> LeafDataProvider for Compact<H, (A, B)>

where H: Hash, A: LeafDataProvider, B: LeafDataProvider,

LeafDataProvider implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

This provides a compact-form encoding for tuples wrapped in Compact.

type LeafData = Compact<H, (DataOrHash<H, <A as LeafDataProvider>::LeafData>, DataOrHash<H, <B as LeafDataProvider>::LeafData>)>

A type that should end up in the leaf of MMR.

fn leaf_data() -> Self::LeafData

The method to return leaf data that should be placed in the leaf node appended MMR at this block.

impl<H, A, B, C> LeafDataProvider for Compact<H, (A, B, C)>

where H: Hash, A: LeafDataProvider, B: LeafDataProvider, C: LeafDataProvider,

LeafDataProvider implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

This provides a compact-form encoding for tuples wrapped in Compact.

type LeafData = Compact<H, (DataOrHash<H, <A as LeafDataProvider>::LeafData>, DataOrHash<H, <B as LeafDataProvider>::LeafData>, DataOrHash<H, <C as LeafDataProvider>::LeafData>)>

A type that should end up in the leaf of MMR.

fn leaf_data() -> Self::LeafData

The method to return leaf data that should be placed in the leaf node appended MMR at this block.

impl<H, A, B, C, D> LeafDataProvider for Compact<H, (A, B, C, D)>

where H: Hash, A: LeafDataProvider, B: LeafDataProvider, C: LeafDataProvider, D: LeafDataProvider,

LeafDataProvider implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

This provides a compact-form encoding for tuples wrapped in Compact.

type LeafData = Compact<H, (DataOrHash<H, <A as LeafDataProvider>::LeafData>, DataOrHash<H, <B as LeafDataProvider>::LeafData>, DataOrHash<H, <C as LeafDataProvider>::LeafData>, DataOrHash<H, <D as LeafDataProvider>::LeafData>)>

A type that should end up in the leaf of MMR.

fn leaf_data() -> Self::LeafData

The method to return leaf data that should be placed in the leaf node appended MMR at this block.

impl<H, A, B, C, D, E> LeafDataProvider for Compact<H, (A, B, C, D, E)>

where H: Hash, A: LeafDataProvider, B: LeafDataProvider, C: LeafDataProvider, D: LeafDataProvider, E: LeafDataProvider,

LeafDataProvider implementation for Compact<H, (DataOrHash<H, Tuple>, ...)>

This provides a compact-form encoding for tuples wrapped in Compact.

type LeafData = Compact<H, (DataOrHash<H, <A as LeafDataProvider>::LeafData>, DataOrHash<H, <B as LeafDataProvider>::LeafData>, DataOrHash<H, <C as LeafDataProvider>::LeafData>, DataOrHash<H, <D as LeafDataProvider>::LeafData>, DataOrHash<H, <E as LeafDataProvider>::LeafData>)>

A type that should end up in the leaf of MMR.

fn leaf_data() -> Self::LeafData

The method to return leaf data that should be placed in the leaf node appended MMR at this block.

impl<H: PartialEq, T: PartialEq> PartialEq for Compact<H, T>

fn eq(&self, other: &Compact<H, 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<H, T> StructuralPartialEq for Compact<H, T>