Enum Value

pub enum Value {
    String(Tag, String),
    Char(Tag, char),
    Bool(Tag, bool),
    Num(Tag, Num),
    Empty(Tag, Empty),
    Dict(Tag, BTreeMap<String, Value>),
    Array(Tag, Vec<Value>),
}

An enum representing all possible figment value variants.

Note that Value implements From<T> for all reasonable T:

use figment::value::Value;

let v = Value::from("hello");
assert_eq!(v.as_str(), Some("hello"));

Variants

String(Tag, String)

A string.

Char(Tag, char)

A character.

Bool(Tag, bool)

A boolean.

Num(Tag, Num)

A numeric value.

Empty(Tag, Empty)

A value with no value.

Dict(Tag, BTreeMap<String, Value>)

A dictionary: a map from String to Value.

Array(Tag, Vec<Value>)

A sequence/array/vector.

Implementations

impl Value

pub fn serialize<T>(value: T) -> Result<Value, Error>

where T: Serialize,

Serialize a Value from any T: Serialize.

use figment::value::{Value, Empty};

let value = Value::serialize(10i8).unwrap();
assert_eq!(value.to_i128(), Some(10));

let value = Value::serialize(()).unwrap();
assert_eq!(value, Empty::Unit.into());

let value = Value::serialize(vec![4, 5, 6]).unwrap();
assert_eq!(value, vec![4, 5, 6].into());

pub fn deserialize<'de, T>(&self) -> Result<T, Error>

where T: Deserialize<'de>,

Deserialize self into any deserializable T.

use figment::value::Value;

let value = Value::from("hello");
let string: String = value.deserialize().unwrap();
assert_eq!(string, "hello");

pub fn find(self, path: &str) -> Option<Value>

Looks up and returns the value at path path, where path is of the form a.b.c where a, b, and c are keys to dictionaries. If the key is empty, simply returns self. If the key is not empty and self or any of the values for non-leaf keys in the path are not dictionaries, returns None.

This method consumes self. See Value::find_ref() for a non-consuming variant.

Example

use figment::{value::Value, util::map};

let value = Value::from(map! {
    "apple" => map! {
        "bat" => map! {
            "pie" => 4usize,
        },
        "cake" => map! {
            "pumpkin" => 10usize,
        }
    }
});

assert!(value.clone().find("apple").is_some());
assert!(value.clone().find("apple.bat").is_some());
assert!(value.clone().find("apple.cake").is_some());

assert_eq!(value.clone().find("apple.bat.pie").unwrap().to_u128(), Some(4));
assert_eq!(value.clone().find("apple.cake.pumpkin").unwrap().to_u128(), Some(10));

assert!(value.clone().find("apple.pie").is_none());
assert!(value.clone().find("pineapple").is_none());

pub fn find_ref<'a>(&'a self, path: &str) -> Option<&'a Value>

Exactly like Value::find() but does not consume self, returning a reference to the found value, if any, instead.

Example

use figment::{value::Value, util::map};

let value = Value::from(map! {
    "apple" => map! {
        "bat" => map! {
            "pie" => 4usize,
        },
        "cake" => map! {
            "pumpkin" => 10usize,
        }
    }
});

assert!(value.find_ref("apple").is_some());
assert!(value.find_ref("apple.bat").is_some());
assert!(value.find_ref("apple.cake").is_some());

assert_eq!(value.find_ref("apple.bat.pie").unwrap().to_u128(), Some(4));
assert_eq!(value.find_ref("apple.cake.pumpkin").unwrap().to_u128(), Some(10));

assert!(value.find_ref("apple.pie").is_none());
assert!(value.find_ref("pineapple").is_none());

pub fn tag(&self) -> Tag

Returns the Tag applied to this value.

use figment::{Figment, Profile, value::Value, util::map};

let map: Value = Figment::from(("key", "value")).extract().unwrap();
let value = map.find_ref("key").expect("value");
assert_eq!(value.as_str(), Some("value"));
assert!(!value.tag().is_default());
assert_eq!(value.tag().profile(), Some(Profile::Global));

let map: Value = Figment::from(("key", map!["key2" => 123])).extract().unwrap();
let value = map.find_ref("key.key2").expect("value");
assert_eq!(value.to_i128(), Some(123));
assert!(!value.tag().is_default());
assert_eq!(value.tag().profile(), Some(Profile::Global));

pub fn as_str(&self) -> Option<&str>

Converts self into a &str if self is a Value::String.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.as_str();

pub fn into_string(self) -> Option<String>

Converts self into a String if self is a Value::String.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.into_string();

pub fn to_char(&self) -> Option<char>

Converts self into a char if self is a Value::Char.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.to_char();

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

Converts self into a bool if self is a Value::Bool.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.to_bool();

pub fn to_num(&self) -> Option<Num>

Converts self into a Num if self is a Value::Num.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.to_num();

pub fn to_empty(&self) -> Option<Empty>

Converts self into a Empty if self is a Value::Empty.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.to_empty();

pub fn as_dict(&self) -> Option<&BTreeMap<String, Value>>

Converts self into a &Dict if self is a Value::Dict.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.as_dict();

pub fn into_dict(self) -> Option<BTreeMap<String, Value>>

Converts self into a Dict if self is a Value::Dict.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.into_dict();

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

Converts self into a &[Value] if self is a Value::Array.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.as_array();

pub fn into_array(self) -> Option<Vec<Value>>

Converts self into a Vec<Value> if self is a Value::Array.

Example

use figment::value::Value;

let value: Value = 123.into();
let converted = value.into_array();

pub fn to_u128(&self) -> Option<u128>

Converts self into a u128 if self is an unsigned Value::Num variant.

Example

use figment::value::Value;

let value: Value = 123u8.into();
let converted = value.to_u128();
assert_eq!(converted, Some(123));

pub fn to_i128(&self) -> Option<i128>

Converts self into an i128 if self is an signed Value::Num variant.

Example

use figment::value::Value;

let value: Value = 123i8.into();
let converted = value.to_i128();
assert_eq!(converted, Some(123));

let value: Value = Value::from(5000i64);
assert_eq!(value.to_i128(), Some(5000i128));

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

Converts self into an f64 if self is either a Num::F32 or Num::F64.

Example

use figment::value::Value;

let value: Value = 7.0f32.into();
let converted = value.to_f64();
assert_eq!(converted, Some(7.0f64));

let value: Value = Value::from(7.0f64);
assert_eq!(value.to_f64(), Some(7.0f64));

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

Converts self to a bool if it is a Value::Bool, or if it is a Value::String or a Value::Num with a boolean interpretation.

The case-insensitive strings “true”, “yes”, “1”, and “on”, and the signed or unsigned integers 1 are interpreted as true.

The case-insensitive strings “false”, “no”, “0”, and “off”, and the signed or unsigned integers 0 are interpreted as false.

Example

use figment::value::Value;

let value = Value::from(true);
assert_eq!(value.to_bool_lossy(), Some(true));

let value = Value::from(1);
assert_eq!(value.to_bool_lossy(), Some(true));

let value = Value::from("YES");
assert_eq!(value.to_bool_lossy(), Some(true));

let value = Value::from(false);
assert_eq!(value.to_bool_lossy(), Some(false));

let value = Value::from(0);
assert_eq!(value.to_bool_lossy(), Some(false));

let value = Value::from("no");
assert_eq!(value.to_bool_lossy(), Some(false));

let value = Value::from("hello");
assert_eq!(value.to_bool_lossy(), None);

pub fn to_num_lossy(&self) -> Option<Num>

Converts self to a Num if it is a Value::Num or if it is a Value::String that parses as a usize (Num::USize), isize (Num::ISize), or f64 (Num::F64), in that order of precendence.

Examples

use figment::value::{Value, Num};

let value = Value::from(7_i32);
assert_eq!(value.to_num_lossy(), Some(Num::I32(7)));

let value = Value::from("7");
assert_eq!(value.to_num_lossy(), Some(Num::U8(7)));

let value = Value::from("-7000");
assert_eq!(value.to_num_lossy(), Some(Num::I16(-7000)));

let value = Value::from("7000.5");
assert_eq!(value.to_num_lossy(), Some(Num::F64(7000.5)));

pub fn to_actual(&self) -> Actual

Converts self into the corresponding Actual.

See also Num::to_actual() and Empty::to_actual(), which are called internally by this method.

Example

use figment::{value::Value, error::Actual};

assert_eq!(Value::from('a').to_actual(), Actual::Char('a'));
assert_eq!(Value::from(&[1, 2, 3]).to_actual(), Actual::Seq);

impl Value

This impl block contains no items.

Marker trait for “magic” values. Primarily for use with [Either].

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<D>(de: D) -> Result<Value, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for &Value

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>(self, v: V) -> Result<<V as Visitor<'de>>::Value, Error>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_option<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_enum<V>( self, _: &'static str, _: &'static [&'static str], v: V, ) -> Result<<V as Visitor<'de>>::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_newtype_struct<V>( self, _name: &'static str, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_bool<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_u8<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_i8<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_f32<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_seq<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_bytes<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_map<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_unit<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_struct<V>( self, name: &'static str, fields: &'static [&'static str], visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_ignored_any<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn deserialize_unit_struct<V>( self, name: &'static str, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_tuple_struct<V>( self, name: &'static str, len: usize, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_tuple<V>( self, len: usize, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_identifier<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, <&Value as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_i128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl<'a, T> From<&'a [T]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 1]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 1]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 2]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 2]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 3]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 3]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 4]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 4]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 5]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 5]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 6]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 6]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 7]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 7]) -> Value

Converts to this type from the input type.

impl<'a, T> From<&'a [T; 8]> for Value

where T: Into<Value> + Clone,

fn from(value: &'a [T; 8]) -> Value

Converts to this type from the input type.

impl From<&str> for Value

fn from(value: &str) -> Value

Converts to this type from the input type.

impl<K, V> From<BTreeMap<K, V>> for Value

where K: AsRef<str>, V: Into<Value>,

fn from(map: BTreeMap<K, V>) -> Value

Converts to this type from the input type.

impl From<Empty> for Value

fn from(value: Empty) -> Value

Converts to this type from the input type.

impl From<Num> for Value

fn from(value: Num) -> Value

Converts to this type from the input type.

impl From<String> for Value

fn from(value: String) -> Value

Converts to this type from the input type.

impl From<Tag> for Value

fn from(tag: Tag) -> Value

Converts to this type from the input type.

impl<'a, T> From<Vec<T>> for Value

where T: Into<Value>,

fn from(vec: Vec<T>) -> Value

Converts to this type from the input type.

impl From<bool> for Value

fn from(value: bool) -> Value

Converts to this type from the input type.

impl From<char> for Value

fn from(value: char) -> Value

Converts to this type from the input type.

impl From<f32> for Value

fn from(value: f32) -> Value

Converts to this type from the input type.

impl From<f64> for Value

fn from(value: f64) -> Value

Converts to this type from the input type.

impl From<i128> for Value

fn from(value: i128) -> Value

Converts to this type from the input type.

impl From<i16> for Value

fn from(value: i16) -> Value

Converts to this type from the input type.

impl From<i32> for Value

fn from(value: i32) -> Value

Converts to this type from the input type.

impl From<i64> for Value

fn from(value: i64) -> Value

Converts to this type from the input type.

impl From<i8> for Value

fn from(value: i8) -> Value

Converts to this type from the input type.

impl From<isize> for Value

fn from(value: isize) -> Value

Converts to this type from the input type.

impl From<u128> for Value

fn from(value: u128) -> Value

Converts to this type from the input type.

impl From<u16> for Value

fn from(value: u16) -> Value

Converts to this type from the input type.

impl From<u32> for Value

fn from(value: u32) -> Value

Converts to this type from the input type.

impl From<u64> for Value

fn from(value: u64) -> Value

Converts to this type from the input type.

impl From<u8> for Value

fn from(value: u8) -> Value

Converts to this type from the input type.

impl From<usize> for Value

fn from(value: usize) -> Value

Converts to this type from the input type.

impl FromStr for Value

type Err = Infallible

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for Value

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

fn serialize<S>( &self, ser: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.