Struct figment::providers::Serialized [−][src]
pub struct Serialized<T> { pub value: T, pub key: Option<String>, pub profile: Profile, // some fields omitted }
Expand description
A Provider
that sources values directly from a serialize type.
Provider Details
-
Profile
This provider does not set a profile.
-
Metadata
This provider is named
T
(viastd::any::type_name
). The source location is set to the call site of the constructor. -
Data (Unkeyed)
When data is not keyed,
T
is expected to serialize to aDict
and is emitted directly as the value for the configured profile. -
Data (Keyed)
When keyed (
Serialized::default()
,Serialized::global()
,Serialized::key()
),T
can serialize to anyValue
and is emitted as the value of the configuredkey
. Specifically, nested dictionaries are created for every path component delimited by.
in the key string (3 ina.b.c
), each dictionary mapping to its parent, and the serializedT
mapping to the leaf.
Fields
value: T
The value to be serialized and used as the provided data.
key: Option<String>
The key path (a.b.c
) to emit the value to or the root if None
.
profile: Profile
The profile to emit the value to. Defaults to Profile::Default
.
Implementations
Constructs an (unkeyed) provider that emits value
, which must
serialize to a dict
, to the profile
.
use serde::Deserialize; use figment::{Figment, Jail, providers::Serialized, util::map}; #[derive(Debug, PartialEq, Deserialize)] struct Config { numbers: Vec<usize>, } Jail::expect_with(|jail| { let map = map!["numbers" => &[1, 2, 3]]; // This is also `Serialized::defaults(&map)`; let figment = Figment::from(Serialized::from(&map, "default")); let config: Config = figment.extract()?; assert_eq!(config, Config { numbers: vec![1, 2, 3] }); // This is also `Serialized::defaults(&map).profile("debug")`; let figment = Figment::from(Serialized::from(&map, "debug")); let config: Config = figment.select("debug").extract()?; assert_eq!(config, Config { numbers: vec![1, 2, 3] }); Ok(()) });
Emits value
, which must serialize to a Dict
, to the Default
profile.
Equivalent to Serialized::from(value, Profile::Default)
.
See Serialized::from()
.
Emits value
, which must serialize to a Dict
, to the Global
profile.
Equivalent to Serialized::from(value, Profile::Global)
.
See Serialized::from()
.
Emits a nested dictionary to the Default
profile keyed by key
with
the final key mapping to value
.
Equivalent for Serialized::from(value, Profile::Default).key(key)
.
See Serialized::from()
and Serialized::key()
.
Emits a nested dictionary to the Global
profile keyed by key
with
the final key mapping to value
.
Equivalent to Serialized::from(value, Profile::Global).key(key)
.
See Serialized::from()
and Serialized::key()
.
Sets the profile to emit the serialized value to.
use figment::{Figment, Jail, providers::Serialized}; Jail::expect_with(|jail| { // This is also `Serialized::defaults(&map)`; let figment = Figment::new() .join(Serialized::default("key", "hey").profile("debug")) .join(Serialized::default("key", "hi")); let value: String = figment.extract_inner("key")?; assert_eq!(value, "hi"); let value: String = figment.select("debug").extract_inner("key")?; assert_eq!(value, "hey"); Ok(()) });
Sets the key to emit the serialized value to.
use figment::{Figment, Jail, providers::Serialized}; Jail::expect_with(|jail| { // This is also `Serialized::defaults(&map)`; let figment = Figment::new() .join(Serialized::default("key", "hey").key("other")) .join(Serialized::default("key", "hi")); let value: String = figment.extract_inner("key")?; assert_eq!(value, "hi"); let value: String = figment.extract_inner("other")?; assert_eq!(value, "hey"); Ok(()) });
Trait Implementations
Auto Trait Implementations
impl<T> RefUnwindSafe for Serialized<T> where
T: RefUnwindSafe,
impl<T> Send for Serialized<T> where
T: Send,
impl<T> Sync for Serialized<T> where
T: Sync,
impl<T> Unpin for Serialized<T> where
T: Unpin,
impl<T> UnwindSafe for Serialized<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V