Struct ParseEvent 

pub struct ParseEvent<'de> {
    pub kind: ParseEventKind<'de>,
    pub span: Span,
    pub meta: Option<ValueMeta<'de>>,
}

Event emitted by a format parser while streaming through input.

Fields

kind: ParseEventKind<'de>

The kind of event.

span: Span

Source span of this event in the input.

meta: Option<ValueMeta<'de>>

Optional metadata (doc comments, type tags) attached to this value.

For most formats (JSON, TOML, etc.) this will be None. Formats like Styx that support documentation comments and type tags on values will populate this.

Implementations

impl<'de> ParseEvent<'de>

pub fn new(kind: ParseEventKind<'de>, span: Span) -> Self

Create a new event with the given kind and span.

pub fn with_meta( self, f: impl FnOnce(ValueMetaBuilder<'de>) -> ValueMetaBuilder<'de>, ) -> Self

Attach metadata to this event using a builder.

Example

ParseEvent::new(kind, span).with_meta(|m| m.doc(lines).tag(tag))

impl ParseEvent<'_>

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 ParseEvent<'de>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Debug for ParseEvent<'de>

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

Formats the value using the given formatter.

impl<'de> PartialEq for ParseEvent<'de>

fn eq(&self, other: &ParseEvent<'de>) -> 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<'de> StructuralPartialEq for ParseEvent<'de>