[][src]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.

Methods

impl Yaml[src]

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

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

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

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

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

pub fn into_bool(self) -> Option<bool>[src]

pub fn into_i64(self) -> Option<i64>[src]

pub fn into_string(self) -> Option<String>[src]

pub fn into_hash(self) -> Option<Hash>[src]

pub fn into_vec(self) -> Option<Array>[src]

pub fn is_null(&self) -> bool[src]

pub fn is_badvalue(&self) -> bool[src]

pub fn is_array(&self) -> bool[src]

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

pub fn into_f64(self) -> Option<f64>[src]

impl Yaml[src]

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

Trait Implementations

impl Clone for Yaml[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl PartialEq<Yaml> for Yaml[src]

impl PartialOrd<Yaml> for Yaml[src]

impl Eq for Yaml[src]

impl Ord for Yaml[src]

fn max(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the minimum of two values. Read more

impl IntoIterator for Yaml[src]

type Item = Yaml

The type of the elements being iterated over.

type IntoIter = YamlIter

Which kind of iterator are we turning this into?

impl Debug for Yaml[src]

impl Hash for Yaml[src]

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

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

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

type Output = Yaml

The returned type after indexing.

impl Index<usize> for Yaml[src]

type Output = Yaml

The returned type after indexing.

Auto Trait Implementations

impl Send for Yaml

impl Sync for Yaml

Blanket Implementations

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.