Struct Tagged

pub struct Tagged<T> { /* private fields */ }

A wrapper around any value of type T and its Tag.

use figment::{Figment, value::magic::Tagged, Jail};
use figment::providers::{Format, Toml};

#[derive(Debug, PartialEq, serde::Deserialize)]
struct Config {
    number: Tagged<usize>,
}

Jail::expect_with(|jail| {
    jail.create_file("Config.toml", r#"number = 10"#)?;
    let figment = Figment::from(Toml::file("Config.toml"));
    let c: Config = figment.extract()?;
    assert_eq!(*c.number, 10);

    let tag = c.number.tag();
    let metadata = figment.get_metadata(tag).expect("number has tag");

    assert!(!tag.is_default());
    assert_eq!(metadata.name, "TOML file");
    Ok(())
});

Implementations

impl<T> Tagged<T>

pub fn tag(&self) -> Tag

Returns the tag of the inner value if it is known. As long self is a leaf and was extracted from a Figment, the returned value is expected to be Some.

Example

use figment::{Figment, Profile, value::magic::Tagged};

let figment = Figment::from(("key", "value"));
let tagged = figment.extract_inner::<Tagged<String>>("key").unwrap();

assert!(!tagged.tag().is_default());
assert_eq!(tagged.tag().profile(), Some(Profile::Global));

pub fn into_inner(self) -> T

Consumes self and returns the inner value.

Example

use figment::{Figment, value::magic::Tagged};

let tagged = Figment::from(("key", "value"))
    .extract_inner::<Tagged<String>>("key")
    .unwrap();

let value = tagged.into_inner();
assert_eq!(value, "value");

Trait Implementations

impl<T> Clone for Tagged<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Tagged<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for Tagged<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Tagged<T> as Deref>::Target

Dereferences the value.

impl<'de, T> Deserialize<'de> for Tagged<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Tagged<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for Tagged<T>

fn from(value: T) -> Tagged<T>

Converts to this type from the input type.

impl<T> PartialEq for Tagged<T>

where T: PartialEq,

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

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Magic for Tagged<T>

where T: for<'de> Deserialize<'de>,