Enum ParseEventKind 

#[non_exhaustive]
pub enum ParseEventKind<'de> {
    StructStart(ContainerKind),
    StructEnd,
    FieldKey(FieldKey<'de>),
    OrderedField,
    SequenceStart(ContainerKind),
    SequenceEnd,
    Scalar(ScalarValue<'de>),
    OptionSome,
    VariantTag(Option<&'de str>),
}

The kind of parse event.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

StructStart(ContainerKind)

Beginning of a struct/object/node.

StructEnd

End of a struct/object/node.

FieldKey(FieldKey<'de>)

Encountered a field key (for self-describing formats like JSON/YAML).

OrderedField

Next field value in struct field order (for non-self-describing formats like postcard).

The driver tracks the current field index and uses the schema to determine which field this value belongs to. This allows formats without field names in the wire format to still support Tier-0 deserialization.

SequenceStart(ContainerKind)

Beginning of a sequence/array/tuple.

SequenceEnd

End of a sequence/array/tuple.

Scalar(ScalarValue<'de>)

Scalar literal.

OptionSome

Explicit marker that an option layer is present.

The following event represents the value inside Some(...). This lets formats distinguish an outer Some(None) from a plain None when deserializing nested options.

VariantTag(Option<&'de str>)

Tagged value from a self-describing format with native tagged union syntax.

This is used by formats like Styx that have explicit tag syntax (e.g., @tag(value)). Most formats (JSON, TOML, etc.) don’t need this - they represent enums as {"variant_name": value} which goes through the struct/field path instead.

None represents a unit tag (bare @ in Styx) with no name.

Implementations

impl ParseEventKind<'_>

pub const fn kind_name(&self) -> &'static str

Returns a static string describing the kind of event for error messages.

Trait Implementations

impl<'de> Clone for ParseEventKind<'de>

fn clone(&self) -> ParseEventKind<'de>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Debug for ParseEventKind<'de>

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

Formats the value using the given formatter.

impl<'de> PartialEq for ParseEventKind<'de>

fn eq(&self, other: &ParseEventKind<'de>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'de> StructuralPartialEq for ParseEventKind<'de>