Enum yaml_rust::yaml::Yaml

pub enum Yaml {
    Real(String),
    Integer(i64),
    String(String),
    Boolean(bool),
    Array(Array),
    Hash(Hash),
    Alias(usize),
    Null,
    BadValue,
}

A YAML node is stored as this Yaml enumeration, which provides an easy way to access your YAML document.

Examples

use yaml_rust::Yaml;
let foo = Yaml::from_str("-123"); // convert the string to the appropriate YAML type
assert_eq!(foo.as_i64().unwrap(), -123);

// iterate over an Array
let vec = Yaml::Array(vec![Yaml::Integer(1), Yaml::Integer(2)]);
for v in vec.as_vec().unwrap() {
    assert!(v.as_i64().is_some());
}

Variants

Real(String)

Float types are stored as String and parsed on demand. Note that f64 does NOT implement Eq trait and can NOT be stored in BTreeMap.

Integer(i64)

YAML int is stored as i64.

String(String)

YAML scalar.

Boolean(bool)

YAML bool, e.g. true or false.

Array(Array)

YAML array, can be accessed as a Vec.

Hash(Hash)

YAML hash, can be accessed as a LinkedHashMap.

Insertion order will match the order of insertion into the map.

Alias(usize)

Alias, not fully supported yet.

Null

YAML null, e.g. null or ~.

BadValue

Accessing a nonexistent node via the Index trait returns BadValue. This simplifies error handling in the calling code. Invalid type conversion also returns BadValue.

Implementations

impl Yaml

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

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

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

pub fn as_hash(&self) -> Option<&Hash>

pub fn as_vec(&self) -> Option<&Array>

pub fn into_bool(self) -> Option<bool>

pub fn into_i64(self) -> Option<i64>

pub fn into_string(self) -> Option<String>

pub fn into_hash(self) -> Option<Hash>

pub fn into_vec(self) -> Option<Array>

pub fn is_null(&self) -> bool

pub fn is_badvalue(&self) -> bool

pub fn is_array(&self) -> bool

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

pub fn into_f64(self) -> Option<f64>

impl Yaml

pub fn from_str(v: &str) -> Yaml

Trait Implementations

impl Clone for Yaml

fn clone(&self) -> Yaml

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Yaml

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

Formats the value using the given formatter.

impl Hash for Yaml

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<'a> Index<&'a str> for Yaml

type Output = Yaml

The returned type after indexing.

fn index(&self, idx: &'a str) -> &Yaml

Performs the indexing (container[index]) operation.

impl Index<usize> for Yaml

type Output = Yaml

The returned type after indexing.

fn index(&self, idx: usize) -> &Yaml

Performs the indexing (container[index]) operation.

impl IntoIterator for Yaml

type Item = Yaml

The type of the elements being iterated over.

type IntoIter = YamlIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Yaml

fn cmp(&self, other: &Yaml) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Yaml> for Yaml

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

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

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

This method tests for !=.

impl PartialOrd<Yaml> for Yaml

fn partial_cmp(&self, other: &Yaml) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Yaml

impl StructuralEq for Yaml

impl StructuralPartialEq for Yaml