Enum YamlNode 

pub enum YamlNode {
    Scalar(Scalar),
    Mapping(Mapping),
    Sequence(Sequence),
    Alias(Alias),
    TaggedNode(TaggedNode),
}

A type-erased handle to a CST node returned from navigation methods.

You get a YamlNode back from methods like Mapping::get, Sequence::get, Mapping::keys, etc.

Match on the variants to get the concrete type, or use the helper methods as_scalar, as_mapping, etc.

use yaml_edit::{Document, YamlNode};
use std::str::FromStr;

let doc = Document::from_str("name: Alice\nage: 30").unwrap();

if let Some(node) = doc.get("name") {
    match node {
        YamlNode::Scalar(s) => println!("scalar: {}", s.as_string()),
        YamlNode::Mapping(m) => println!("mapping with {} keys", m.len()),
        YamlNode::Sequence(s) => println!("sequence with {} items", s.len()),
        YamlNode::Alias(a) => println!("alias: *{}", a.name()),
        YamlNode::TaggedNode(t) => println!("tagged: {:?}", t.tag()),
    }
}

Variants

Scalar(Scalar)

A scalar value (string, integer, float, boolean, null).

Mapping(Mapping)

A key-value mapping.

Sequence(Sequence)

An ordered sequence.

Alias(Alias)

An alias reference (e.g. *anchor_name).

TaggedNode(TaggedNode)

A tagged node (e.g. !!set, !!omap, !!pairs, or a custom tag).

Implementations

impl YamlNode

pub fn from_syntax(node: SyntaxNode<Lang>) -> Option<Self>

Cast a SyntaxNode to a YamlNode.

Returns None if the node’s kind is not one of SCALAR, MAPPING, SEQUENCE, ALIAS, or TAGGED_NODE.

pub fn kind(&self) -> YamlKind

Returns the kind of YAML value this node represents.

pub fn yaml_eq<O: AsYaml>(&self, other: &O) -> bool

Compare semantically with another value (ignores quoting/formatting).

pub fn as_scalar(&self) -> Option<&Scalar>

If this node is a scalar, return a reference to it.

pub fn as_mapping(&self) -> Option<&Mapping>

If this node is a mapping, return a reference to it.

pub fn as_sequence(&self) -> Option<&Sequence>

If this node is a sequence, return a reference to it.

pub fn as_tagged(&self) -> Option<&TaggedNode>

If this node is a tagged node, return a reference to it.

pub fn as_alias(&self) -> Option<&Alias>

If this node is an alias, return a reference to it.

pub fn is_scalar(&self) -> bool

Returns true if this node is a scalar.

pub fn is_mapping(&self) -> bool

Returns true if this node is a mapping.

pub fn is_sequence(&self) -> bool

Returns true if this node is a sequence.

pub fn is_tagged(&self) -> bool

Returns true if this node is a tagged node.

pub fn is_alias(&self) -> bool

Returns true if this node is an alias.

pub fn to_i64(&self) -> Option<i64>

If this node is a scalar, try to parse it as an i64.

Returns None if this is not a scalar or cannot be parsed as an integer.

pub fn to_f64(&self) -> Option<f64>

If this node is a scalar, try to parse it as an f64.

Returns None if this is not a scalar or cannot be parsed as a float.

pub fn to_bool(&self) -> Option<bool>

If this node is a scalar, try to parse it as a bool.

Returns None if this is not a scalar or cannot be parsed as a boolean.

pub fn get(&self, key: impl AsYaml) -> Option<YamlNode>

Get a value by key from a mapping node.

Returns None if this node is not a mapping or the key is not found.

pub fn get_item(&self, index: usize) -> Option<YamlNode>

Get a value by index from a sequence node.

Returns None if this node is not a sequence or the index is out of bounds.

Trait Implementations

impl AsYaml for YamlNode

fn as_node(&self) -> Option<&SyntaxNode<Lang>>

Returns a reference to the underlying SyntaxNode if one exists.

fn kind(&self) -> YamlKind

Returns the kind of YAML value this represents.

fn build_content( &self, builder: &mut GreenNodeBuilder<'_>, _indent: usize, _flow_context: bool, ) -> bool

Serialize this value into a GreenNodeBuilder.

fn is_inline(&self) -> bool

Returns whether this value should be rendered on the same line as its key.

impl Clone for YamlNode

fn clone(&self) -> YamlNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YamlNode

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

Formats the value using the given formatter.

impl Display for YamlNode

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

Formats the value using the given formatter.

impl PartialEq<&str> for YamlNode

fn eq(&self, other: &&str) -> 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 PartialEq<String> for YamlNode

fn eq(&self, other: &String) -> 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 PartialEq<str> for YamlNode

yaml_node == "some_string" — compares the node’s semantic value.

fn eq(&self, other: &str) -> 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 PartialEq for YamlNode

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