Trait bilrost::WithCanonicity

pub trait WithCanonicity {
    type Value;
    type WithoutCanonicity;

    // Required methods
    fn canonical(self) -> Result<Self::Value, DecodeErrorKind>;
    fn canonical_with_extensions(self) -> Result<Self::Value, DecodeErrorKind>;
    fn value(self) -> Self::WithoutCanonicity;
}

Trait for values and results bearing canonicity information (represented by the Canonicity enum).

Required Associated Types

type Value

The type of the value without any canonicity information.

type WithoutCanonicity

Required Methods

fn canonical(self) -> Result<Self::Value, DecodeErrorKind>

Get the value if it is fully canonical, otherwise returning an error.

fn canonical_with_extensions(self) -> Result<Self::Value, DecodeErrorKind>

Get the value as long as its known fields are canonical, otherwise returning an error.

fn value(self) -> Self::WithoutCanonicity

Discards the canonicity.

If this method is always being used and canonicity information is always discarded, distinguished decoding may not be needed, and the program can be made more efficient by simply using expedient decoding mode.

Implementations on Foreign Types

impl<'a, T> WithCanonicity for &'a (T, Canonicity)

type Value = &'a T

type WithoutCanonicity = <&'a (T, Canonicity) as WithCanonicity>::Value

fn canonical(self) -> Result<&'a T, DecodeErrorKind>

fn canonical_with_extensions(self) -> Result<&'a T, DecodeErrorKind>

fn value(self) -> &'a T

impl<T> WithCanonicity for (T, Canonicity)

type Value = T

type WithoutCanonicity = <(T, Canonicity) as WithCanonicity>::Value

fn canonical(self) -> Result<T, DecodeErrorKind>

fn canonical_with_extensions(self) -> Result<T, DecodeErrorKind>

fn value(self) -> T

impl<T, E> WithCanonicity for Result<T, E>

where T: WithCanonicity, DecodeErrorKind: From<E>,

type Value = <T as WithCanonicity>::Value

type WithoutCanonicity = Result<<T as WithCanonicity>::WithoutCanonicity, DecodeErrorKind>

fn canonical(self) -> Result<T::Value, DecodeErrorKind>

fn canonical_with_extensions(self) -> Result<T::Value, DecodeErrorKind>

fn value(self) -> Result<T::WithoutCanonicity, DecodeErrorKind>

Implementors

impl WithCanonicity for &Canonicity

type Value = ()

type WithoutCanonicity = <&Canonicity as WithCanonicity>::Value

impl WithCanonicity for Canonicity

type Value = ()

type WithoutCanonicity = <Canonicity as WithCanonicity>::Value