# Enum yaml_rust::yaml::Yaml

source · [−]

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

Expand description

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

source

### impl Yaml

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

#### pub fn is_null(&self) -> bool

source

#### pub fn is_badvalue(&self) -> bool

source

#### pub fn is_array(&self) -> bool

source

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

source

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

source

### impl Yaml

source

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

## Trait Implementations

source

### impl Clone for Yaml

source

#### fn clone(&self) -> Yaml

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl Debug for Yaml

source

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

Formats the value using the given formatter. Read more

source

### impl Hash for Yaml

source

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

Feeds this value into the given `Hasher`. Read more

1.3.0 · source

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

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

source

### impl<'a> Index<&'a str> for Yaml

#### type Output = Yaml

The returned type after indexing.

source

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

Performs the indexing (`container[index]`) operation. Read more

source

### impl Index<usize> for Yaml

#### type Output = Yaml

The returned type after indexing.

source

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

Performs the indexing (`container[index]`) operation. Read more

source

### 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?

source

#### fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

source

### impl Ord for Yaml

source

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

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

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

#### fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

### impl PartialEq<Yaml> for Yaml

source

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

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

source

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

This method tests for `!=`.

source

### impl PartialOrd<Yaml> for Yaml

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

### impl Eq for Yaml

source

### impl StructuralEq for Yaml

source

### impl StructuralPartialEq for Yaml

## Auto Trait Implementations

### impl RefUnwindSafe for Yaml

### impl Send for Yaml

### impl Sync for Yaml

### impl Unpin for Yaml

### impl UnwindSafe for Yaml

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.