Struct TomlKeyPath 

pub struct TomlKeyPath(/* private fields */);

A path to a key into a toml::Value. In the format of key.0.key (0 for indexing into an array) when parsed using FromStr.

See TomlKeyPath::resolve() for an example.

Implementations

impl TomlKeyPath

pub fn resolve<'a>(&self, value: &'a Value) -> Option<&'a Value>

Resolve a value contained within a toml::Value using this TomlKeyPath.

Example

use toml_env::TomlKeyPath;
use toml;

let toml_value = toml::from_str(r#"
key="value1"
array=["hello", "world"]
[child]
key="value2"
"#).unwrap();

let key1: TomlKeyPath = "key".parse().unwrap();
let key1_value = key1.resolve(&toml_value)
    .expect("Expected to resolve")
    .as_str()
    .expect("Expected to be a string");
assert_eq!(key1_value, "value1");

let key2: TomlKeyPath = "child.key".parse().unwrap();
let key2_value = key2.resolve(&toml_value)
    .expect("Expected to resolve")
    .as_str()
    .expect("Expected to be a string");
assert_eq!(key2_value, "value2");

let hello: TomlKeyPath = "array.0".parse().unwrap();
let hello_value = hello.resolve(&toml_value)
    .expect("Expected to resolve")
    .as_str()
    .expect("Expected to be a string");
assert_eq!(hello_value, "hello");

Trait Implementations

impl Clone for TomlKeyPath

fn clone(&self) -> TomlKeyPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TomlKeyPath

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

Formats the value using the given formatter.

impl Default for TomlKeyPath

fn default() -> TomlKeyPath

Returns the “default value” for a type.

impl Display for TomlKeyPath

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

Formats the value using the given formatter.

impl FromStr for TomlKeyPath

fn from_str(s: &str) -> Result<Self, ()>

Parse a string into a TomlKeyPath.

Example

use toml_env::TomlKeyPath;

"key".parse::<TomlKeyPath>().unwrap();
"key.0".parse::<TomlKeyPath>().unwrap();
"key.key".parse::<TomlKeyPath>().unwrap();
"key.0.key".parse::<TomlKeyPath>().unwrap();
"key.key.key".parse::<TomlKeyPath>().unwrap();
"".parse::<TomlKeyPath>().unwrap();
".".parse::<TomlKeyPath>().unwrap();
".key".parse::<TomlKeyPath>().unwrap();
"key.".parse::<TomlKeyPath>().unwrap();

type Err = ()

The associated error which can be returned from parsing.