Struct Commits

pub struct Commits<T: Config<I>, I: 'static = ()>(WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>);

Represents a collection of individual commit instances of a proprietor for a specific digest (direct/index/pool) and commitment reason.

The association with a single digest and reason is not structurally enforced at this level; instead, it is guaranteed by higher-level structures (typically CommitInfo).

Each commit is stored as a CommitInstance within a [WeakBoundedVec], bounding the number of commits per (digest, reason) pair to Config::MaxCommits.

Tuple Fields

0: WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>

Implementations

impl<T: Config<I>, I: 'static> Commits<T, I>

pub(crate) fn new(instance: CommitInstance<T, I>) -> Result<Self, DispatchError>

Initializes a new collection of commits with a single CommitInstance, typically derived from LazyBalance deposit operations.

This establishes the initial commit, after which additional commits may be appended via Commits::add_commit.

pub(crate) fn add_commit( &mut self, instance: CommitInstance<T, I>, ) -> Result<(), DispatchError>

Adds a new commitment instance to the existing commits collection.

Returns DispatchError if the bounded vector capacity is exhausted.

pub fn commits(&self) -> WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>

Trait Implementations

impl<T: Clone + Config<I>, I: Clone + 'static> Clone for Commits<T, I>

where T::MaxCommits: Clone,

fn clone(&self) -> Commits<T, I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, I> Debug for Commits<T, I>

where T: Debug + Config<I>, I: Debug + 'static,

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> Decode for Commits<T, I>

where WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> 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<T: Config<I>, I: 'static> Encode for Commits<T, I>

where WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config<I>, I: 'static> MaxEncodedLen for Commits<T, I>

where WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T: Config<I>, I: 'static> PartialEq for Commits<T, I>

fn eq(&self, other: &Self) -> 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, I> TypeInfo for Commits<T, I>

where WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>: TypeInfo + 'static, T: Config<I> + 'static, I: 'static,

type Identity = Commits<T, I>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config<I>, I: 'static> DecodeWithMemTracking for Commits<T, I>

where WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>: DecodeWithMemTracking,

impl<T: Config<I>, I: 'static> EncodeLike for Commits<T, I>

where WeakBoundedVec<CommitInstance<T, I>, T::MaxCommits>: Encode,

impl<T: Config<I>, I: 'static> Eq for Commits<T, I>