Struct sp_consensus_beefy::mmr::MmrLeafVersion

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

An MMR leaf versioning scheme.

Version is a single byte that consists of two components:

• major - 3 bits
• minor - 5 bits

Any change in encoding that adds new items to the structure is considered non-breaking, hence only requires an update of minor version. Any backward incompatible change (i.e. decoding to a previous leaf format fails) should be indicated with major version bump.

Given that adding new struct elements in SCALE is backward compatible (i.e. old format can be still decoded, the new fields will simply be ignored). We expect the major version to be bumped very rarely (hopefully never).

Implementations

impl MmrLeafVersion

pub fn new(major: u8, minor: u8) -> Self

Create new version object from major and minor components.

Panics if any of the component occupies more than 4 bits.

pub fn split(&self) -> (u8, u8)

Split the version into major and minor sub-components.

Trait Implementations

impl Clone for MmrLeafVersion

fn clone(&self) -> MmrLeafVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MmrLeafVersion

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

Formats the value using the given formatter.

impl Decode for MmrLeafVersion

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 Default for MmrLeafVersion

fn default() -> MmrLeafVersion

Returns the “default value” for a type.

impl Encode for MmrLeafVersion

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 PartialEq for MmrLeafVersion

fn eq(&self, other: &MmrLeafVersion) -> 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 TypeInfo for MmrLeafVersion

type Identity = MmrLeafVersion

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for MmrLeafVersion

impl Eq for MmrLeafVersion

impl StructuralPartialEq for MmrLeafVersion