Enum Node 

pub enum Node<Loc = Span> {
    Scalar {
        value: String,
        style: ScalarStyle,
        anchor: Option<String>,
        anchor_loc: Option<Loc>,
        tag: Option<String>,
        tag_loc: Option<Loc>,
        loc: Loc,
        leading_comments: Option<Vec<String>>,
        trailing_comment: Option<String>,
    },
    Mapping {
        entries: Vec<(Self, Self)>,
        style: CollectionStyle,
        anchor: Option<String>,
        anchor_loc: Option<Loc>,
        tag: Option<String>,
        tag_loc: Option<Loc>,
        loc: Loc,
        leading_comments: Option<Vec<String>>,
        trailing_comment: Option<String>,
    },
    Sequence {
        items: Vec<Self>,
        style: CollectionStyle,
        anchor: Option<String>,
        anchor_loc: Option<Loc>,
        tag: Option<String>,
        tag_loc: Option<Loc>,
        loc: Loc,
        leading_comments: Option<Vec<String>>,
        trailing_comment: Option<String>,
    },
    Alias {
        name: String,
        loc: Loc,
        leading_comments: Option<Vec<String>>,
        trailing_comment: Option<String>,
    },
}

A YAML node parameterized by its location type.

Variants

Scalar

A scalar value.

Fields

value: String

The scalar content as a UTF-8 string (after block/flow unfolding).

style: ScalarStyle

The presentation style used in the source (plain, single-quoted, etc.).

anchor: Option<String>

Anchor name defined on this node (e.g. &anchor), if any.

anchor_loc: Option<Loc>

Source span of the &name anchor token — from & through the last byte of the name. Some when anchor is Some; None otherwise.

tag: Option<String>

Tag applied to this node (e.g. !!str), if any.

tag_loc: Option<Loc>

Source span of the tag token — from ! through the last byte of the tag. Some when tag is Some; None otherwise.

loc: Loc

Source span covering this scalar in the input.

leading_comments: Option<Vec<String>>

Comment lines that appear before this node (e.g. # note). Populated only for non-first entries in a mapping or sequence. Document-prefix leading comments are discarded by the tokenizer per YAML §9.2 and cannot be recovered here.

trailing_comment: Option<String>

Inline comment on the same line as this node (e.g. # note).

Mapping

A mapping (sequence of key–value pairs preserving declaration order).

Fields

entries: Vec<(Self, Self)>

Key–value pairs in declaration order.

style: CollectionStyle

The presentation style used in the source (block or flow).

anchor: Option<String>

Anchor name defined on this mapping (e.g. &anchor), if any.

anchor_loc: Option<Loc>

Source span of the &name anchor token — from & through the last byte of the name. Some when anchor is Some; None otherwise.

tag: Option<String>

Tag applied to this mapping (e.g. !!map), if any.

tag_loc: Option<Loc>

Source span of the tag token — from ! through the last byte of the tag. Some when tag is Some; None otherwise.

loc: Loc

Source span from the opening indicator to the last entry.

leading_comments: Option<Vec<String>>

Comment lines that appear before this node.

trailing_comment: Option<String>

Inline comment on the same line as this node.

Sequence

A sequence (ordered list of nodes).

Fields

items: Vec<Self>

Ordered list of child nodes.

style: CollectionStyle

The presentation style used in the source (block or flow).

anchor: Option<String>

Anchor name defined on this sequence (e.g. &anchor), if any.

anchor_loc: Option<Loc>

Source span of the &name anchor token — from & through the last byte of the name. Some when anchor is Some; None otherwise.

tag: Option<String>

Tag applied to this sequence (e.g. !!seq), if any.

tag_loc: Option<Loc>

Source span of the tag token — from ! through the last byte of the tag. Some when tag is Some; None otherwise.

loc: Loc

Source span from the opening indicator to the last item.

leading_comments: Option<Vec<String>>

Comment lines that appear before this node.

trailing_comment: Option<String>

Inline comment on the same line as this node.

Alias

An alias reference (lossless mode only — resolved mode expands these).

Fields

name: String

The anchor name this alias refers to (without the * sigil).

loc: Loc

Source span covering the *name alias token.

leading_comments: Option<Vec<String>>

Comment lines that appear before this node.

trailing_comment: Option<String>

Inline comment on the same line as this node.

Implementations

impl<Loc> Node<Loc>

pub fn anchor(&self) -> Option<&str>

Returns the anchor name if this node defines one.

pub const fn anchor_loc(&self) -> Option<Loc>

where Loc: Copy,

Returns the source span of the &name anchor token, if any.

Some(span) when anchor() is Some; None otherwise. Always None for Node::Alias — the alias span is in loc.

pub const fn tag_loc(&self) -> Option<Loc>

where Loc: Copy,

Returns the source span of the tag token, if any.

Some(span) when tag() is Some; None otherwise. Always None for Node::Alias.

pub fn leading_comments(&self) -> &[String]

Returns the leading comments for this node.

pub fn trailing_comment(&self) -> Option<&str>

Returns the trailing comment for this node, if any.

Trait Implementations

impl<Loc: Clone> Clone for Node<Loc>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Loc: Debug> Debug for Node<Loc>

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

Formats the value using the given formatter.

impl<Loc: PartialEq> PartialEq for Node<Loc>

fn eq(&self, other: &Node<Loc>) -> 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<Loc> StructuralPartialEq for Node<Loc>