Struct Document

pub struct Document<'input> {
    pub events: Vec<(Event<'input>, Mark)>,
    pub error: Option<Arc<ErrorImpl>>,
    pub anchor_event_map: BTreeMap<usize, usize>,
}

Represents a YAML document.

Fields

events: Vec<(Event<'input>, Mark)>

The parsed events of the document.

This field contains a vector of (Event<'input>, Mark) tuples, where:

• Event<'input> represents a parsed YAML event, such as a scalar, sequence, or mapping. The 'input lifetime parameter indicates the lifetime of the input data associated with the event.
• Mark represents the position in the input where the event was encountered.

error: Option<Arc<ErrorImpl>>

Any error encountered during parsing.

This field is an optional Arc<ErrorImpl>, where:

• Arc is a reference-counted smart pointer that allows multiple ownership of the error.
• ErrorImpl is the underlying error type that holds the details of the parsing error.

If an error occurs during parsing, this field will contain Some(error). Otherwise, it will be None.

anchor_event_map: BTreeMap<usize, usize>

Map from alias id to index in events.

This field is a BTreeMap that maps alias ids to their corresponding index in the events vector.

In YAML, an alias is a reference to a previously defined anchor. When an alias is encountered during parsing, its id is used to look up the index of the corresponding event in the events vector.

Trait Implementations

impl<'input> Debug for Document<'input>

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

Formats the value using the given formatter.