Struct Event

pub struct Event {
    pub event_type: EventType,
    pub position: Position,
}

Represents a YAML parsing event

Fields

event_type: EventType

The type of event

position: Position

Position where the event occurred

Implementations

impl Event

pub const fn new(event_type: EventType, position: Position) -> Self

Create a new event

pub const fn stream_start(position: Position) -> Self

Create a stream start event

pub const fn stream_end(position: Position) -> Self

Create a stream end event

pub const fn document_start( position: Position, version: Option<(u8, u8)>, tags: Vec<(String, String)>, implicit: bool, ) -> Self

Create a document start event

pub const fn document_end(position: Position, implicit: bool) -> Self

Create a document end event

pub const fn scalar( position: Position, anchor: Option<String>, tag: Option<String>, value: String, plain_implicit: bool, quoted_implicit: bool, style: ScalarStyle, ) -> Self

Create a scalar event

pub const fn sequence_start( position: Position, anchor: Option<String>, tag: Option<String>, flow_style: bool, ) -> Self

Create a sequence start event

pub const fn sequence_end(position: Position) -> Self

Create a sequence end event

pub const fn mapping_start( position: Position, anchor: Option<String>, tag: Option<String>, flow_style: bool, ) -> Self

Create a mapping start event

pub const fn mapping_end(position: Position) -> Self

Create a mapping end event

pub const fn alias(position: Position, anchor: String) -> Self

Create an alias event

pub const fn is_collection_start(&self) -> bool

Check if this is a collection start event

pub const fn is_collection_end(&self) -> bool

Check if this is a collection end event

pub const fn is_document_boundary(&self) -> bool

Check if this is a document boundary event

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Display for Event

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

Formats the value using the given formatter.

impl PartialEq for Event

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

impl StructuralPartialEq for Event