Struct scale_info::TypeDefVariant

pub struct TypeDefVariant<T: Form = MetaForm> { /* fields omitted */ }

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, // Also allows to manually set the discriminant!
    Friday,
    Saturday,
    Sunday,
}

An empty enum (for marker purposes)

enum JustAMarker {}

Implementations

impl TypeDefVariant

pub fn new<I>(variants: I) -> Self where
    I: IntoIterator<Item = Variant>, 

Create a new TypeDefVariant with the given variants

impl<T> TypeDefVariant<T> where
    T: Form, 

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

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.

pub 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,
    Vec<Variant<T>>: Decode, 

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

pub fn skip<I>(input: &mut I) -> Result<(), Error> where
    I: Input, 

Attempt to skip the encoded value from input.

pub 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,
    Vec<Variant<T>>: Encode, 

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<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

pub fn size_hint(&self) -> usize

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

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Form> EncodeLike<TypeDefVariant<T>> for TypeDefVariant<T> where
    Vec<Variant<T>>: Encode,
    Vec<Variant<T>>: Encode, 

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

impl<T: Form> From<TypeDefVariant<T>> for TypeDef<T>

fn from(original: TypeDefVariant<T>) -> TypeDef<T>

Performs the conversion.

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

fn from(original: Vec<Variant<T>>) -> TypeDefVariant<T>

Performs the conversion.

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.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

fn eq(&self, other: &TypeDefVariant<T>) -> bool

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

fn ne(&self, other: &TypeDefVariant<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + Form> PartialOrd<TypeDefVariant<T>> 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: &TypeDefVariant<T>) -> bool

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

fn le(&self, other: &TypeDefVariant<T>) -> bool

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

fn gt(&self, other: &TypeDefVariant<T>) -> bool

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

fn ge(&self, other: &TypeDefVariant<T>) -> bool

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

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

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