Enum strict_yaml_rust::strict_yaml::StrictYaml

pub enum StrictYaml {
    String(String),
    Array(Array),
    Hash(Hash),
    BadValue,
}

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

Examples

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

// iterate over an Array
let vec = StrictYaml::Array(vec![StrictYaml::String("1".into()), StrictYaml::String("2".into())]);
for v in vec.as_vec().unwrap() {
    assert!(v.as_str().is_some());
}

Variants

String(String)

YAML scalar.

Array(Array)

YAML array, can be accessed as a Vec.

Hash(Hash)

YAML hash, can be accessed as a LinkedHashMap. Iteration order will match the order of insertion into the map.

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 StrictYaml

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

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

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

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

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

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

pub fn is_badvalue(&self) -> bool

pub fn is_array(&self) -> bool

impl StrictYaml

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

Trait Implementations

impl Clone for StrictYaml

fn clone(&self) -> StrictYaml

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StrictYaml

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

Formats the value using the given formatter.

impl Hash for StrictYaml

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 StrictYaml

type Output = StrictYaml

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for StrictYaml

type Output = StrictYaml

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IntoIterator for StrictYaml

type Item = StrictYaml

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 StrictYaml

fn cmp(&self, other: &StrictYaml) -> 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<StrictYaml> for StrictYaml

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

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

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

This method tests for !=.

impl PartialOrd<StrictYaml> for StrictYaml

fn partial_cmp(&self, other: &StrictYaml) -> 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 StrictYaml

impl StructuralEq for StrictYaml

impl StructuralPartialEq for StrictYaml