Enum marked_yaml::types::Node

pub enum Node {
    Scalar(MarkedScalarNode),
    Mapping(MarkedMappingNode),
    Sequence(MarkedSequenceNode),
}

A marked YAML node

NOTE: Nodes are considered equal even if they don't come from the same place. i.e. their spans are ignored for equality and hashing

use marked_yaml::parse_yaml;
let node = parse_yaml(100, "{foo: bar}").unwrap();
assert!(node.as_mapping().is_some());

Variants

Scalar(MarkedScalarNode)

A YAML scalar

You can test if a node is a scalar, and retrieve it as one if you so wish.

Mapping(MarkedMappingNode)

A YAML mapping

You can test if a node is a mapping, and retrieve it as one if you so wish.

Sequence(MarkedSequenceNode)

A YAML sequence

You can test if a node is a sequence, and retrieve it as one if you so wish.

Methods

impl Node

pub fn span(&self) -> &Span

Retrieve the Span from the contained Node

let node: Node = "foobar".into();
let span = node.span();
assert_eq!(span.start(), None);

pub fn span_mut(&mut self) -> &mut Span

Retrieve the Span from the contained Node, mutably

let mut node: Node = "foobar".into();
let mut span = node.span_mut();
assert_eq!(span.start(), None);
span.set_start(Some(Marker::new(0, 1, 0)));
assert_eq!(span.start(), Some(&Marker::new(0, 1, 0)));

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

Retrieve the scalar from this node if there is one

let node: Node = "foobar".into();
let scalar = node.as_scalar();
assert!(scalar.is_some());

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

Retrieve the sequence from this node if there is one

let node: Node = vec!["foobar"].into();
let sequence = node.as_sequence();
assert!(sequence.is_some());

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

Retrieve the mapping from this node if there is one

let node: Node = parse_yaml(0, "{foobar: baz}").unwrap();
let mapping = node.as_mapping();
assert!(mapping.is_some());

pub fn as_scalar_mut(&mut self) -> Option<&mut MarkedScalarNode>

Retrieve the scalar from this node if there is one, mutably

let mut node: Node = "foobar".into();
let mut scalar = node.as_scalar_mut();
assert!(scalar.is_some());

pub fn as_sequence_mut(&mut self) -> Option<&mut MarkedSequenceNode>

Retrieve the sequence from this node if there is one, mutably

let mut node: Node = vec!["foobar"].into();
let mut sequence = node.as_sequence_mut();
assert!(sequence.is_some());

pub fn as_mapping_mut(&mut self) -> Option<&mut MarkedMappingNode>

Retrieve the mapping from this node if there is one, mutably

let mut node: Node = parse_yaml(0, "{foobar: baz}").unwrap();
let mut mapping = node.as_mapping_mut();
assert!(mapping.is_some());

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Eq for Node

impl From<LinkedHashMap<MarkedScalarNode, Node, RandomState>> for Node

fn from(value: LinkedHashMap<MarkedScalarNode, Node>) -> Node

Performs the conversion.

impl From<MarkedMappingNode> for Node

fn from(value: MarkedMappingNode) -> Node

Performs the conversion.

impl From<MarkedSequenceNode> for Node

fn from(value: MarkedSequenceNode) -> Node

Performs the conversion.

impl From<Node> for YamlNode

fn from(value: Node) -> Self

Performs the conversion.

impl<T> From<T> for Node where
    T: Into<MarkedScalarNode>, 

fn from(value: T) -> Node

Performs the conversion.

impl<T> From<Vec<T>> for Node where
    T: Into<Node>, 

fn from(value: Vec<T>) -> Node

Performs the conversion.

impl Hash for Node

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Node> for Node

fn eq(&self, other: &Node) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Node) -> bool

This method tests for !=.

impl StructuralEq for Node

impl StructuralPartialEq for Node

impl TryFrom<Yaml> for Node

type Error = YamlConversionError

The type returned in the event of a conversion error.

fn try_from(value: YamlNode) -> Result<Self, Self::Error>

Convert from any yaml_rust::Yaml to a Node

let docs = YamlLoader::load_from_str("[1, 2]").unwrap();
let yaml = docs.into_iter().next().unwrap();
let node = Node::try_from(yaml).unwrap();