Struct scale_info::Variant

pub struct Variant<F: Form = MetaForm> { /* fields omitted */ }

A struct enum variant with either named (struct) or unnamed (tuple struct) fields.

Example

enum Operation {
    Zero,
//  ^^^^ this is a unit struct enum variant
    Add(i32, i32),
//  ^^^^^^^^^^^^^ this is a tuple-struct enum variant
    Minus { source: i32 }
//  ^^^^^^^^^^^^^^^^^^^^^ this is a struct enum variant
}

Implementations

impl Variant

pub fn with_fields<F>(name: &'static str, fields: FieldsBuilder<F>) -> Self

Creates a new variant with the given fields.

pub fn with_discriminant(name: &'static str, discriminant: u64) -> Self

Creates a new variant with the given discriminant.

Trait Implementations

impl<F: Clone + Form> Clone for Variant<F>

fn clone(&self) -> Variant<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Form> Debug for Variant<F>

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

Formats the value using the given formatter.

impl<F: Eq + Form> Eq for Variant<F>

impl IntoCompact for Variant

type Output = Variant<CompactForm>

The compact version of Self.

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

Compacts self by using the registry for caching and compaction.

impl<F: Ord + Form> Ord for Variant<F>

fn cmp(&self, other: &Variant<F>) -> Ordering

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<F: PartialEq + Form> PartialEq<Variant<F>> for Variant<F>

fn eq(&self, other: &Variant<F>) -> bool

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

fn ne(&self, other: &Variant<F>) -> bool

This method tests for !=.

impl<F: PartialOrd + Form> PartialOrd<Variant<F>> for Variant<F>

fn partial_cmp(&self, other: &Variant<F>) -> Option<Ordering>

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

fn lt(&self, other: &Variant<F>) -> bool

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

fn le(&self, other: &Variant<F>) -> bool

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

fn gt(&self, other: &Variant<F>) -> bool

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

fn ge(&self, other: &Variant<F>) -> bool

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

impl<F: Form> Serialize for Variant<F> where
    F::TypeId: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<F: Form> StructuralEq for Variant<F>

impl<F: Form> StructuralPartialEq for Variant<F>