Enum figment::value::Value [−][src]
pub enum Value { String(Tag, String), Char(Tag, char), Bool(Tag, bool), Num(Tag, Num), Empty(Tag, Empty), Dict(Tag, Dict), Array(Tag, Vec<Value>), }
Expand description
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
A string.
A character.
A boolean.
A numeric value.
A value with no value.
A dictionary: a map from String
to Value
.
A sequence/array/vector.
Implementations
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());
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");
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());
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());
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));
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();
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();
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();
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();
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();
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();
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();
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();
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();
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();
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));
Converts self
into a u128
if self
is an unsigned Value::Num
variant.
Example
use figment::value::Value; let value: Value = 123i8.into(); let converted = value.to_i128(); assert_eq!(converted, Some(123));
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);
Trait Implementations
Deserialize this value from the given Serde deserializer. Read more
The error type that can be returned if some error occurs during deserialization. Read more
Require the Deserializer
to figure out how to drive the visitor based
on what data type is in the input. Read more
Hint that the Deserialize
type is expecting an optional value. Read more
fn deserialize_enum<V: Visitor<'de>>(
self,
_: &'static str,
_: &'static [&'static str],
v: V
) -> Result<V::Value>
fn deserialize_enum<V: Visitor<'de>>(
self,
_: &'static str,
_: &'static [&'static str],
v: V
) -> Result<V::Value>
Hint that the Deserialize
type is expecting an enum value with a
particular name and possible variants. Read more
Hint that the Deserialize
type is expecting a bool
value.
Hint that the Deserialize
type is expecting a u8
value.
Hint that the Deserialize
type is expecting a u16
value.
Hint that the Deserialize
type is expecting a u32
value.
Hint that the Deserialize
type is expecting a u64
value.
Hint that the Deserialize
type is expecting an i8
value.
Hint that the Deserialize
type is expecting an i16
value.
Hint that the Deserialize
type is expecting an i32
value.
Hint that the Deserialize
type is expecting an i64
value.
Hint that the Deserialize
type is expecting a f32
value.
Hint that the Deserialize
type is expecting a f64
value.
Hint that the Deserialize
type is expecting a char
value.
Hint that the Deserialize
type is expecting a string value and does
not benefit from taking ownership of buffered data owned by the
Deserializer
. Read more
Hint that the Deserialize
type is expecting a string value and would
benefit from taking ownership of buffered data owned by the
Deserializer
. Read more
Hint that the Deserialize
type is expecting a sequence of values.
Hint that the Deserialize
type is expecting a byte array and does not
benefit from taking ownership of buffered data owned by the
Deserializer
. Read more
Hint that the Deserialize
type is expecting a byte array and would
benefit from taking ownership of buffered data owned by the
Deserializer
. Read more
Hint that the Deserialize
type is expecting a map of key-value pairs.
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::Value, Self::Error> where
V: Visitor<'de>,
fn deserialize_struct<V>(
self,
name: &'static str,
fields: &'static [&'static str],
visitor: V
) -> Result<V::Value, Self::Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a struct with a particular
name and fields. Read more
Hint that the Deserialize
type is expecting a newtype struct with a
particular name. Read more
Hint that the Deserialize
type needs to deserialize a value whose type
doesn’t matter because it is ignored. Read more
Hint that the Deserialize
type is expecting a unit struct with a
particular name. Read more
Hint that the Deserialize
type is expecting a tuple struct with a
particular name and number of fields. Read more
Hint that the Deserialize
type is expecting a sequence of values and
knows how many values there are without looking at the serialized data. Read more
Hint that the Deserialize
type is expecting the name of a struct
field or the discriminant of an enum variant. Read more
Hint that the Deserialize
type is expecting an i128
value. Read more
Hint that the Deserialize
type is expecting an u128
value. Read more
Determine whether Deserialize
implementations should expect to
deserialize their human-readable form. Read more
type Err = Infallible
type Err = Infallible
The associated error which can be returned from parsing.
Auto Trait Implementations
impl RefUnwindSafe for Value
impl UnwindSafe for Value
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V