Struct Document 

pub struct Document<Loc = Span> {
    pub root: Node<Loc>,
    pub version: Option<(u8, u8)>,
    pub tags: Vec<(String, String)>,
    pub comments: Vec<String>,
    pub explicit_start: bool,
    pub explicit_end: bool,
    /* private fields */
}

A YAML document: a root node plus directive metadata.

Fields

root: Node<Loc>

The root node of the document.

version: Option<(u8, u8)>

YAML version declared by a %YAML directive, if present (e.g. (1, 2)).

tags: Vec<(String, String)>

Tag handle/prefix pairs declared by %TAG directives (handle, prefix).

comments: Vec<String>

Comments that appear at document level (before or between nodes).

explicit_start: bool

Whether the document was introduced with an explicit --- marker.

explicit_end: bool

Whether the document was closed with an explicit ... marker.

Implementations

impl<Loc> Document<Loc>

pub const fn with_root(root: Node<Loc>) -> Self

Construct a document with the given root node and all metadata set to their default values.

This constructor is intended for unit tests that synthesise AST nodes without going through the loader. The line_index is set to None; calling line_index() on the resulting document will panic.

impl Document<Span>

pub fn line_index(&self) -> &LineIndex

Return the LineIndex for this document, used to resolve byte offsets from Span values to (line, column) pairs.

Panics

Panics if the document was not created by the loader (i.e., line_index is None). All documents returned by load() or Loader::load() have a LineIndex set.

Trait Implementations

impl<Loc: Clone> Clone for Document<Loc>

fn clone(&self) -> Document<Loc>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Loc: Debug> Debug for Document<Loc>

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

Formats the value using the given formatter.

impl<Loc: PartialEq> PartialEq for Document<Loc>

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