Enum Event 

pub enum Event<'src> {
    DocumentStart,
    DocumentEnd,
    ObjectStart {
        span: Span,
        separator: Separator,
    },
    ObjectEnd {
        span: Span,
    },
    SequenceStart {
        span: Span,
    },
    SequenceEnd {
        span: Span,
    },
    EntryStart,
    Key {
        span: Span,
        tag: Option<&'src str>,
        payload: Option<Cow<'src, str>>,
        kind: ScalarKind,
    },
    EntryEnd,
    Scalar {
        span: Span,
        value: Cow<'src, str>,
        kind: ScalarKind,
    },
    Unit {
        span: Span,
    },
    TagStart {
        span: Span,
        name: &'src str,
    },
    TagEnd,
    Comment {
        span: Span,
        text: &'src str,
    },
    DocComment {
        span: Span,
        text: &'src str,
    },
    Error {
        span: Span,
        kind: ParseErrorKind,
    },
}

Events emitted by the parser.

Variants

DocumentStart

Start of document.

DocumentEnd

End of document.

ObjectStart

Start of an object { ... }.

Fields

span: Span

Span of the opening brace.

separator: Separator

Detected separator mode.

ObjectEnd

End of an object.

Fields

span: Span

Span of the closing brace.

SequenceStart

Start of a sequence ( ... ).

Fields

span: Span

Span of the opening paren.

SequenceEnd

End of a sequence.

Fields

span: Span

Span of the closing paren.

EntryStart

Start of an entry (key-value pair).

Key

A key in an entry.

Keys can be scalars or unit, optionally tagged. Objects, sequences, and heredocs are not allowed as keys.

Fields

span: Span

Span of the key.

tag: Option<&'src str>

Tag name if this key is tagged (without @).

payload: Option<Cow<'src, str>>

Scalar payload after escape processing. None means unit.

kind: ScalarKind

Kind of scalar used for the key. Only meaningful if payload is Some.

EntryEnd

End of an entry.

Scalar

A scalar value.

Fields

span: Span

Span of the scalar.

value: Cow<'src, str>

Value after escape processing.

kind: ScalarKind

Kind of scalar.

Unit

Unit value @.

Fields

span: Span

Span of the unit.

TagStart

Start of a tag @name.

Fields

span: Span

Span of the tag (including @).

name: &'src str

Tag name (without @).

TagEnd

End of a tag.

Comment

Line comment // ....

Fields

span: Span

Span of the comment.

text: &'src str

Comment text (including //).

DocComment

Doc comment /// ....

Fields

span: Span

Span of the doc comment.

text: &'src str

Doc comment text (including ///).

Error

Parse error.

Fields

span: Span

Span where error occurred.

kind: ParseErrorKind

Kind of error.

Trait Implementations

impl<'src> Clone for Event<'src>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for Event<'src>

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

Formats the value using the given formatter.

impl<'src> PartialEq for Event<'src>

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

impl<'src> StructuralPartialEq for Event<'src>