Struct YamlHash 

pub struct YamlHash { /* private fields */ }

Improved YAML Hash

• Convert from &str via impl From<&str>
• Convert to String via impl Display
• Get a value for a dotted key as a YamlHash or yaml_rust2::Yaml via get and get_yaml
• Merge a YamlHash with another YamlHash, YAML hash string, or YAML hash file to create a new YamlHash via merge, merge_str, or merge_file

Implementations

impl YamlHash

pub fn new() -> YamlHash

Create a new empty YamlHash

pub fn merge(&self, other: &YamlHash) -> YamlHash

Merge this YamlHash with another YamlHash to create a new YamlHash

use yaml_hash::YamlHash;

let hash = YamlHash::from("\
fruit:
  apple: 1
  banana: 2\
");

let other = YamlHash::from("\
fruit:
  cherry:
    sweet: 1
    tart: 2\
");

assert_eq!(
    hash.merge(&other).to_string(),
    "\
fruit:
  apple: 1
  banana: 2
  cherry:
    sweet: 1
    tart: 2\
    ",
);

pub fn merge_str(&self, s: &str) -> Result<YamlHash>

Merge this YamlHash with a YAML hash &str to create a new YamlHash

use yaml_hash::YamlHash;

let hash = YamlHash::from("\
fruit:
  apple: 1
  banana: 2\
");

let hash = hash.merge_str("\
fruit:
  cherry:
    sweet: 1
    tart: 2\
").unwrap();

assert_eq!(
    hash.to_string(),
    "\
fruit:
  apple: 1
  banana: 2
  cherry:
    sweet: 1
    tart: 2\
    ",
);

Errors

Returns an error if the YAML string is not a hash

pub fn merge_file<P: AsRef<Path>>(&self, path: P) -> Result<YamlHash>

Merge this YamlHash with a YAML hash file to create a new YamlHash

use yaml_hash::YamlHash;

let hash = YamlHash::from("\
fruit:
  apple: 1
  banana: 2\
");

let hash = hash.merge_file("tests/b.yaml").unwrap();

assert_eq!(
    hash.to_string(),
    "\
fruit:
  apple: 1
  banana: 2
  cherry: 3\
    ",
);

Errors

Returns an error if not able to read the file at the given path to a string

pub fn get_yaml(&self, key: &str) -> Result<Yaml>

Get the value for a dotted key as a Yaml

use yaml_hash::{Yaml, YamlHash};

let hash = YamlHash::from("\
fruit:
  apple: 1
  banana: 2
  cherry:
    sweet: 1
    tart: 2\
");

assert_eq!(
    hash.get_yaml("fruit.cherry.tart").unwrap(),
    Yaml::Integer(2),
);

Errors

Returns an error if the given key is not valid or the value is not a hash

pub fn get(&self, key: &str) -> Result<YamlHash>

Get a value for a dotted key as a YamlHash

use yaml_hash::YamlHash;

let hash = YamlHash::from("\
fruit:
  apple: 1
  banana: 2
  cherry:
    sweet: 1
    tart: 2\
");

assert_eq!(
    hash.get("fruit.cherry").unwrap(),
    YamlHash::from("\
sweet: 1
tart: 2\
    "),
);

Errors

Returns an error if the given key is not valid or the value is not a hash

Trait Implementations

impl Clone for YamlHash

fn clone(&self) -> YamlHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YamlHash

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

Formats the value using the given formatter.

impl Default for YamlHash

fn default() -> YamlHash

Returns the “default value” for a type.

impl Display for YamlHash

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

Formats the value using the given formatter.

impl From<&str> for YamlHash

fn from(s: &str) -> YamlHash

Create a YamlHash from a YAML hash string

impl PartialEq for YamlHash

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for YamlHash

impl StructuralPartialEq for YamlHash