Enum yaml_rust_davvid::yaml::Yaml [−][src]
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_davvid::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.
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
.
Implementations
impl Yaml
[src]
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]
Trait Implementations
impl IntoIterator for Yaml
[src]
impl IntoIterator for Yaml
[src]impl Ord for Yaml
[src]
impl Ord for Yaml
[src]impl PartialOrd<Yaml> for Yaml
[src]
impl PartialOrd<Yaml> for Yaml
[src]fn partial_cmp(&self, other: &Yaml) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Yaml) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Eq for Yaml
[src]
impl StructuralEq for Yaml
[src]
impl StructuralPartialEq for Yaml
[src]
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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more