Struct figment::providers::Serialized

pub struct Serialized<T> {
    pub value: T,
    pub key: Option<String>,
    pub profile: Profile,
    /* private fields */
}

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 (via std::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 a Dict 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 any Value and is emitted as the value of the configured key key path. Nested dictionaries are created for every path component delimited by . in the key string, each dictionary mapping the path component to the child, with the leaf mapping to the serialized T. 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

impl<T> 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(())
});

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().

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().

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().

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().

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(())
});

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

impl<T: Clone> Clone for Serialized<T>

fn clone(&self) -> Serialized<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Serialized<T>

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

Formats the value using the given formatter.

impl<T: Serialize> Provider for Serialized<T>

fn metadata(&self) -> Metadata

Returns the Metadata for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.