Struct EnumVariantSchema 

#[non_exhaustive]
pub struct EnumVariantSchema {
    pub discriminant: u32,
    pub name: String,
    pub payload: Box<DynamicSchema>,
}

One variant of a DynamicSchema::Enum description.

discriminant is the varint u32 postcard writes for this variant (postcard uses the Rust enum’s declaration order, so the first variant has discriminant 0, the second 1, and so on — #[serde(other)] / explicit discriminants change this). name is the Rust variant identifier carried through to the decoded Dynamic::Enum so a Migrate::migrate impl can distinguish variants by name. payload is the variant’s inner shape, Boxed because DynamicSchema is self-referential.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

discriminant: u32

Postcard’s varint u32 discriminant for this variant.

name: String

The Rust variant identifier, carried into Dynamic::Enum verbatim.

payload: Box<DynamicSchema>

Wire shape of the variant’s payload. Use DynamicSchema::Null for unit variants; DynamicSchema::Map for tuple and struct variants (synthetic numeric names for tuple variants); the inner type’s schema for newtype variants.

Implementations

impl EnumVariantSchema

pub fn new<S>( discriminant: u32, name: S, payload: DynamicSchema, ) -> EnumVariantSchema

where S: Into<String>,

Convenience constructor: lift a (discriminant, name, payload) triple into an EnumVariantSchema. The Box around the payload is added internally.

Trait Implementations

impl Clone for EnumVariantSchema

fn clone(&self) -> EnumVariantSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnumVariantSchema

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

Formats the value using the given formatter.

impl PartialEq for EnumVariantSchema

fn eq(&self, other: &EnumVariantSchema) -> 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 Eq for EnumVariantSchema

impl StructuralPartialEq for EnumVariantSchema