Struct sp_consensus_beefy::Payload

pub struct Payload(/* private fields */);

A BEEFY payload type allowing for future extensibility of adding additional kinds of payloads.

The idea is to store a vector of SCALE-encoded values with an extra identifier. Identifiers MUST be sorted by the BeefyPayloadId to allow efficient lookup of expected value. Duplicated identifiers are disallowed. It’s okay for different implementations to only support a subset of possible values.

Implementations

impl Payload

pub fn from_single_entry(id: BeefyPayloadId, value: Vec<u8>) -> Self

Construct a new payload given an initial value

pub fn get_raw(&self, id: &BeefyPayloadId) -> Option<&Vec<u8>>

Returns a raw payload under given id.

If the BeefyPayloadId is not found in the payload None is returned.

pub fn get_all_raw<'a>( &'a self, id: &'a BeefyPayloadId, ) -> impl Iterator<Item = &Vec<u8>> + 'a

Returns all the raw payloads under given id.

pub fn get_decoded<T: Decode>(&self, id: &BeefyPayloadId) -> Option<T>

Returns a decoded payload value under given id.

In case the value is not there, or it cannot be decoded None is returned.

pub fn get_all_decoded<'a, T: Decode>( &'a self, id: &'a BeefyPayloadId, ) -> impl Iterator<Item = Option<T>> + 'a

Returns all decoded payload values under given id.

pub fn push_raw(self, id: BeefyPayloadId, value: Vec<u8>) -> Self

Push a Vec<u8> with a given id into the payload vec. This method will internally sort the payload vec after every push.

Returns self to allow for daisy chaining.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Decode for Payload

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 Encode for Payload

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 Hash for Payload

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Payload

fn cmp(&self, other: &Payload) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Payload

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Payload

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

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

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

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

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

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

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

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

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 TypeInfo for Payload

type Identity = Payload

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for Payload

impl Eq for Payload

impl StructuralPartialEq for Payload