Struct figment::providers::Serialized
source · pub struct Serialized<T> {
pub value: T,
pub key: Option<String>,
pub profile: Profile,
/* private fields */
}
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
key path. Nested dictionaries are created for every path component delimited by.
in thekey
string, each dictionary mapping the path component to the child, with the leaf mapping to the serializedT
. For instance,a.b.c
results in{ a: { b: { c: T }}}
.
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§
source§impl<T> Serialized<T>
impl<T> Serialized<T>
sourcepub fn from<P: Into<Profile>>(value: T, profile: P) -> Serialized<T>
pub fn from<P: Into<Profile>>(value: T, profile: P) -> Serialized<T>
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(())
});
sourcepub fn defaults(value: T) -> Serialized<T>
pub fn defaults(value: T) -> Serialized<T>
Emits value
, which must serialize to a Dict
, to the Default
profile.
Equivalent to Serialized::from(value, Profile::Default)
.
See Serialized::from()
.
sourcepub fn globals(value: T) -> Serialized<T>
pub fn globals(value: T) -> Serialized<T>
Emits value
, which must serialize to a Dict
, to the Global
profile.
Equivalent to Serialized::from(value, Profile::Global)
.
See Serialized::from()
.
sourcepub fn default(key: &str, value: T) -> Serialized<T>
pub fn default(key: &str, value: T) -> Serialized<T>
Emits a nested dictionary to the Default
profile keyed by key
key path with the final key mapping to value
.
See Data (keyed) for key path details.
Equivalent to Serialized::from(value, Profile::Default).key(key)
.
See Serialized::from()
and Serialized::key()
.
sourcepub fn global(key: &str, value: T) -> Serialized<T>
pub fn global(key: &str, value: T) -> Serialized<T>
Emits a nested dictionary to the Global
profile keyed by key
with
the final key mapping to value
.
See Data (keyed) for key path details.
Equivalent to Serialized::from(value, Profile::Global).key(key)
.
See Serialized::from()
and Serialized::key()
.
sourcepub fn profile<P: Into<Profile>>(self, profile: P) -> Self
pub fn profile<P: Into<Profile>>(self, profile: P) -> Self
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(())
});
sourcepub fn key(self, key: &str) -> Self
pub fn key(self, key: &str) -> Self
Sets the key path to emit the serialized value to.
See Data (keyed) for key path details.
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§
source§impl<T: Clone> Clone for Serialized<T>
impl<T: Clone> Clone for Serialized<T>
source§fn clone(&self) -> Serialized<T>
fn clone(&self) -> Serialized<T>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<T: Debug> Debug for Serialized<T>
impl<T: Debug> Debug for Serialized<T>
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
Example
println!("{}", value.bright_yellow());
source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.bright_magenta());
source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
Example
println!("{}", value.on_bright_black());
source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
Example
println!("{}", value.on_bright_white());
source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
Example
println!("{}", value.rapid_blink());
source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);