Enum asciii::Yaml
[−]
[src]
pub enum Yaml { Real(String), Integer(i64), String(String), Boolean(bool), Array(Vec<Yaml>), Hash(LinkedHashMap<Yaml, Yaml, RandomState>), 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(Vec<Yaml>)
YAML array, can be accessed as a Vec
.
Hash(LinkedHashMap<Yaml, Yaml, RandomState>)
YAML hash, can be accessed as a LinkedHashMap
.
Itertion 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]
fn as_bool(&self) -> Option<bool>
[src]
fn as_i64(&self) -> Option<i64>
[src]
fn as_str(&self) -> Option<&str>
[src]
fn as_hash(&self) -> Option<&LinkedHashMap<Yaml, Yaml, RandomState>>
[src]
fn as_vec(&self) -> Option<&Vec<Yaml>>
[src]
fn into_bool(self) -> Option<bool>
[src]
fn into_i64(self) -> Option<i64>
[src]
fn into_string(self) -> Option<String>
[src]
fn into_hash(self) -> Option<LinkedHashMap<Yaml, Yaml, RandomState>>
[src]
fn into_vec(self) -> Option<Vec<Yaml>>
[src]
fn is_null(&self) -> bool
[src]
fn is_badvalue(&self) -> bool
[src]
fn is_array(&self) -> bool
[src]
fn as_f64(&self) -> Option<f64>
[src]
fn into_f64(self) -> Option<f64>
[src]
impl Yaml
[src]
Trait Implementations
impl Ord for Yaml
[src]
impl Index<usize> for Yaml
[src]
impl<'a> Index<&'a str> for Yaml
[src]
impl Hash for Yaml
[src]
fn hash<__H>(&self, __arg_0: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Clone for Yaml
[src]
fn clone(&self) -> Yaml
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Eq for Yaml
[src]
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?
fn into_iter(self) -> <Yaml as IntoIterator>::IntoIter
[src]
Creates an iterator from a value. Read more
impl PartialEq<Yaml> for Yaml
[src]
fn eq(&self, __arg_0: &Yaml) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Yaml) -> bool
[src]
This method tests for !=
.
impl Debug for Yaml
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter.