Enum yaml_rust::yaml::Yaml[][src]

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

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.

YAML int is stored as i64.

YAML scalar.

YAML bool, e.g. true or false.

YAML array, can be accessed as a Vec.

YAML hash, can be accessed as a LinkedHashMap.

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

Alias, not fully supported yet.

YAML null, e.g. null or ~.

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

Methods

impl Yaml
[src]

impl Yaml
[src]

Trait Implementations

impl Clone for Yaml
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl PartialEq for Yaml
[src]

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

This method tests for !=.

impl PartialOrd for Yaml
[src]

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

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

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

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

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

impl Debug for Yaml
[src]

Formats the value using the given formatter. Read more

impl Eq for Yaml
[src]

impl Ord for Yaml
[src]

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl Hash for Yaml
[src]

Feeds this value into the given [Hasher]. Read more

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

impl<'a> Index<&'a str> for Yaml
[src]

The returned type after indexing.

Performs the indexing (container[index]) operation.

impl Index<usize> for Yaml
[src]

The returned type after indexing.

Performs the indexing (container[index]) operation.

impl IntoIterator for Yaml
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

Auto Trait Implementations

impl Send for Yaml

impl Sync for Yaml