Enum Event

pub enum Event<'input> {
    Nothing,
    StreamStart,
    StreamEnd,
    DocumentStart(bool),
    DocumentEnd,
    Alias(usize),
    Scalar(Cow<'input, str>, ScalarStyle, usize, Option<Cow<'input, Tag>>),
    SequenceStart(usize, Option<Cow<'input, Tag>>),
    SequenceEnd,
    MappingStart(usize, Option<Cow<'input, Tag>>),
    MappingEnd,
}

An event generated by the YAML parser.

Events are used in the low-level event-based API (push parser). The API entrypoint is the EventReceiver trait.

Variants

Nothing

Reserved for internal use.

StreamStart

Event generated at the very beginning of parsing.

StreamEnd

Last event that will be generated by the parser. Signals EOF.

DocumentStart(bool)

The start of a YAML document.

When the boolean is true, it is an explicit document start directive (---).

When the boolean is false, it is an implicit document start (without ---).

DocumentEnd

The YAML end document directive (...).

Alias(usize)

A YAML Alias.

Tuple Fields

0: usize

The anchor ID the alias refers to.

Scalar(Cow<'input, str>, ScalarStyle, usize, Option<Cow<'input, Tag>>)

Value, style, anchor_id, tag

SequenceStart(usize, Option<Cow<'input, Tag>>)

The start of a YAML sequence (array).

Tuple Fields

0: usize

The anchor ID of the start of the sequence.

1: Option<Cow<'input, Tag>>

An optional tag

SequenceEnd

The end of a YAML sequence (array).

MappingStart(usize, Option<Cow<'input, Tag>>)

The start of a YAML mapping (object, hash).

Tuple Fields

0: usize

The anchor ID of the start of the mapping.

1: Option<Cow<'input, Tag>>

An optional tag

MappingEnd

The end of a YAML mapping (object, hash).

Trait Implementations

impl<'input> Clone for Event<'input>

fn clone(&self) -> Event<'input>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for Event<'input>

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

Formats the value using the given formatter.

impl<'input> PartialEq for Event<'input>

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

impl<'input> StructuralPartialEq for Event<'input>