Struct ConfigValue 

pub struct ConfigValue { /* private fields */ }

A parsed configuration value.

Use Config::get or Config::select for path-aware fallible lookups with detailed error messages. The indexing API on this type is intentionally panicking and is meant only as a convenience shorthand.

Implementations

impl ConfigValue

pub fn to_toml_fragment(&self) -> String

Render this value as a TOML fragment.

pub fn as_string(&self) -> Option<String>

Return the value as a string if possible.

pub fn as_i64(&self) -> Option<i64>

Return the value as an integer if possible.

pub fn as_f64(&self) -> Option<f64>

Return the value as a float if possible.

pub fn as_bool(&self) -> Option<bool>

Return the value as a boolean if possible.

pub fn as_datetime(&self) -> Option<&Datetime>

Return the value as a TOML datetime if possible.

pub fn as_bytes(&self) -> Option<u64>

Return the value as a byte size if possible.

pub fn as_duration(&self) -> Option<Duration>

Return the value as a duration if possible.

pub fn as_array(&self) -> Option<&[ConfigValue]>

Return the value as an array slice if possible.

This is useful when callers need to discover which array indices are present instead of probing individual indices with Index.

use kompact::config::parse_config_str;

let conf = parse_config_str("values = [1, 2, 3]").expect("config");
let values = conf["values"].as_array().expect("array");

assert_eq!(3, values.len());
assert_eq!(Some(2), values[1].as_i64());

Trait Implementations

impl Clone for ConfigValue

fn clone(&self) -> ConfigValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigValue

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

Formats the value using the given formatter.

impl Index<&str> for ConfigValue

type Output = ConfigValue

The returned type after indexing.

fn index(&self, key: &str) -> &<ConfigValue as Index<&str>>::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for ConfigValue

type Output = ConfigValue

The returned type after indexing.

fn index(&self, index: usize) -> &<ConfigValue as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl PartialEq for ConfigValue

fn eq(&self, other: &ConfigValue) -> 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 StructuralPartialEq for ConfigValue