Struct TypeDefVariant

pub struct TypeDefVariant<T: Form = MetaForm> {
    pub variants: Vec<Variant<T>>,
}

A Enum type (consisting of variants).

Examples

A Rust enum, aka tagged union.

enum MyEnum {
    RustAllowsForClikeVariants,
    AndAlsoForTupleStructs(i32, bool),
    OrStructs {
        with: i32,
        named: bool,
        fields: [u8; 32],
    },
    ItIsntPossibleToSetADiscriminantThough,
}

A C-like enum type.

enum Days {
    Monday,
    Tuesday,
    Wednesday,
    Thursday = 42, // Allows setting the discriminant explicitly
    Friday,
    Saturday,
    Sunday,
}

An empty enum (for marker purposes)

enum JustAMarker {}

Fields

variants: Vec<Variant<T>>

The variants of a variant type

Implementations

impl<T> TypeDefVariant<T>

where T: Form,

pub fn new<I>(variants: I) -> Self

where I: IntoIterator<Item = Variant<T>>,

Create a new TypeDefVariant with the given variants

impl<T> TypeDefVariant<T>

where T: Form,

pub fn variants(&self) -> &[Variant<T>]

👎Deprecated since 2.5.0: Prefer to access the fields directly; this getter will be removed in the next major version

Returns the variants of a variant type

Trait Implementations

impl<T: Clone + Form> Clone for TypeDefVariant<T>

fn clone(&self) -> TypeDefVariant<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Form> Debug for TypeDefVariant<T>

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

Formats the value using the given formatter.

impl<T: Form> Decode for TypeDefVariant<T>

where Vec<Variant<T>>: 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: Form> Encode for TypeDefVariant<T>

where Vec<Variant<T>>: 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<__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<F: Form> From<TypeDefVariant<F>> for TypeDef<F>

fn from(x: TypeDefVariant<F>) -> Self

Converts to this type from the input type.

impl<T: Form> From<Vec<Variant<T>>> for TypeDefVariant<T>

fn from(value: Vec<Variant<T>>) -> Self

Converts to this type from the input type.

impl IntoPortable for TypeDefVariant

type Output = TypeDefVariant<PortableForm>

The portable version of Self.

fn into_portable(self, registry: &mut Registry) -> Self::Output

Convert self to the portable form by using the registry for caching.

impl<T: Ord + Form> Ord for TypeDefVariant<T>

fn cmp(&self, other: &TypeDefVariant<T>) -> 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,

Restrict a value to a certain interval.

impl<T: PartialEq + Form> PartialEq for TypeDefVariant<T>

fn eq(&self, other: &TypeDefVariant<T>) -> 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: PartialOrd + Form> PartialOrd for TypeDefVariant<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Form> EncodeLike for TypeDefVariant<T>

where Vec<Variant<T>>: Encode,

impl<T: Eq + Form> Eq for TypeDefVariant<T>

impl<T: Form> StructuralPartialEq for TypeDefVariant<T>