Enum serde_reflection::VariantFormat

pub enum VariantFormat {
    Variable(Variable<VariantFormat>),
    Unit,
    NewType(Box<Format>),
    Tuple(Vec<Format>),
    Struct(Vec<Named<Format>>),
}

Description of a variant in an enum.

Variants

Variable(Variable<VariantFormat>)

A variant whose format is initially unknown. Used internally for tracing. Not (de)serializable.

Unit

A variant without parameters, e.g. A in enum X { A }

NewType(Box<Format>)

A variant with a single unnamed parameter, e.g. A in enum X { A(u16) }

Tuple(Vec<Format>)

A struct with several unnamed parameters, e.g. A in enum X { A(u16, u32) }

Struct(Vec<Named<Format>>)

A struct with named parameters, e.g. A in enum X { A { a: Foo } }

Implementations

impl VariantFormat

pub fn unknown() -> Self

Return a format made of a fresh variable with no known value.

Trait Implementations

impl Clone for VariantFormat

fn clone(&self) -> VariantFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariantFormat

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

Formats the value using the given formatter.

impl Default for VariantFormat

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for VariantFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for VariantFormat

impl FormatHolder for VariantFormat

fn visit<'a>(
    &'a self,
    f: &mut dyn FnMut(&'a Format) -> Result<()>
) -> Result<()>

Visit all the formats in self in a depth-first way. Variables are not supported and will cause an error.

fn visit_mut(
    &mut self,
    f: &mut dyn FnMut(&mut Format) -> Result<()>
) -> Result<()>

Mutably visit all the formats in self in a depth-first way. * Replace variables (if any) with their known values then apply the visiting function f. * Return an error if any variable has still an unknown value (thus cannot be removed).

fn unify(&mut self, format: VariantFormat) -> Result<()>

Update variables and add missing enum variants so that the terms match. This is a special case of term unification: * Variables occurring in other must be "fresh" and distinct from each other. By "fresh", we mean that they do not occur in self and have no known value yet. * If needed, enums in self will be extended with new variants taken from other. * Although the parameter other is consumed (i.e. taken by value), all variables occurring either in self or other are correctly updated.

fn is_unknown(&self) -> bool

Whether this format is a variable with no known value yet.

fn normalize(&mut self) -> Result<()>

Finalize the formats within self by removing variables and making sure that all eligible tuples are compressed into a TupleArray. Return an error if any variable has an unknown value.

fn reduce(&mut self)

Attempt to remove known variables within self. Silently abort if some variables have unknown values.

impl PartialEq<VariantFormat> for VariantFormat

fn eq(&self, other: &VariantFormat) -> bool

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

fn ne(&self, other: &VariantFormat) -> bool

This method tests for !=.

impl Serialize for VariantFormat

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

Serialize this value into the given Serde serializer.

impl StructuralEq for VariantFormat

impl StructuralPartialEq for VariantFormat