Struct IndexOfReason

pub struct IndexOfReason<T: Config<I>, I: 'static = ()> {
    pub reason: CommitReason<T, I>,
    pub index: IndexInfo<T, I>,
}

A composite structure combining a commit reason with an index.

This struct is primarily used as a key generation seed for creating unique digests associated with an index under a specific reason. By combining both the reason and the IndexInfo itself, the resulting hash is unique and deterministic for the given combination.

Used in functions like gen_index_digest to ensure that the same index under the same reason always produces the same digest, while different reasons or different index contents yield different digests.

Fields

reason: CommitReason<T, I>

The reason or context under which this index is associated.

index: IndexInfo<T, I>

The index information being combined with the reason for key generation.

Implementations

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

pub fn new( reason: CommitReason<T, I>, index: IndexInfo<T, I>, ) -> IndexOfReason<T, I>

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, I> Debug for IndexOfReason<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 IndexOfReason<T, I>

where CommitReason<T, I>: Decode, IndexInfo<T, I>: 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 IndexOfReason<T, I>

where CommitReason<T, I>: Encode, IndexInfo<T, I>: 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<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

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 IndexOfReason<T, I>

where CommitReason<T, I>: MaxEncodedLen, IndexInfo<T, I>: MaxEncodedLen,

fn max_encoded_len() -> usize

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

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

fn eq(&self, other: &IndexOfReason<T, I>) -> 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 IndexOfReason<T, I>

where CommitReason<T, I>: TypeInfo + 'static, IndexInfo<T, I>: TypeInfo + 'static, T: Config<I> + 'static, I: 'static,

type Identity = IndexOfReason<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 IndexOfReason<T, I>

where CommitReason<T, I>: DecodeWithMemTracking, IndexInfo<T, I>: DecodeWithMemTracking,

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

where CommitReason<T, I>: Encode, IndexInfo<T, I>: Encode,

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

impl<T: Config<I>, I: 'static> StructuralPartialEq for IndexOfReason<T, I>