Enum phron_finality::VersionedEitherMessage

pub enum VersionedEitherMessage<L, R> {
    Left(L),
    Right(R),
}

The main purpose of this data type is to enable a seamless transition between protocol versions at the Network level. It provides a generic implementation of the Decode and Encode traits (LE byte representation) by prepending byte representations for provided type parameters with their version (they need to implement the Versioned trait). If one provides data types that declares equal versions, the first data type parameter will have priority while decoding. Keep in mind that in such case, decode might fail even if the second data type would be able decode provided byte representation.

Variants

Left(L)

Right(R)

Trait Implementations

impl<L: Clone, R: Clone> Clone for VersionedEitherMessage<L, R>

fn clone(&self) -> VersionedEitherMessage<L, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Versioned + Decode, R: Versioned + Decode> Decode for VersionedEitherMessage<L, R>

fn decode<I: Input>(input: &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<L: Versioned + Encode, R: Versioned + Encode> Encode for VersionedEitherMessage<L, R>

fn size_hint(&self) -> usize

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

fn encode_to<T: Output + ?Sized>(&self, dest: &mut T)

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 From<Split<NetworkData<Wrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, Message<SignableHash<<Header<u32, BlakeTwo256> as Header>::Hash>, Signature, SignatureSet<Signature>>>> for VersionedEitherMessage<Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>, Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>>

fn from( data: Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>> ) -> Self

Converts to this type from the input type.

impl From<Split<NetworkData<Wrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, Message<SignableHash<<Header<u32, BlakeTwo256> as Header>::Hash>, Signature, SignatureSet<Signature>>>> for VersionedEitherMessage<Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>, Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>>

fn from( data: Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>> ) -> Self

Converts to this type from the input type.

impl TryFrom<VersionedEitherMessage<Split<NetworkData<Wrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, Message<SignableHash<<Header<u32, BlakeTwo256> as Header>::Hash>, Signature, SignatureSet<Signature>>>, Split<NetworkData<Wrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, Message<SignableHash<<Header<u32, BlakeTwo256> as Header>::Hash>, Signature, SignatureSet<Signature>>>>> for Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>

type Error = VersionedTryFromError

The type returned in the event of a conversion error.

fn try_from( value: VersionedEitherMessage<Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>, Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>> ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<VersionedEitherMessage<Split<NetworkData<Wrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, Message<SignableHash<<Header<u32, BlakeTwo256> as Header>::Hash>, Signature, SignatureSet<Signature>>>, Split<NetworkData<Wrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, Message<SignableHash<<Header<u32, BlakeTwo256> as Header>::Hash>, Signature, SignatureSet<Signature>>>>> for Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>

type Error = VersionedTryFromError

The type returned in the event of a conversion error.

fn try_from( value: VersionedEitherMessage<Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>, Split<NetworkData<HashWrapper<BlakeTwo256>, PhronData, Signature, SignatureSet<Signature>>, RmcNetworkData<BlockHash, Signature, SignatureSet<Signature>>>> ) -> Result<Self, Self::Error>

Performs the conversion.