Struct figment::value::magic::Tagged

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

This is supported on crate feature magic only.

A wrapper around any value of type T and the metadata Id of the provider that sourced the value.

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 metadata = c.number.metadata_id()
        .and_then(|id| figment.get_metadata(id))
        .expect("number has metadata id, figment has metadata");

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

Implementations

impl<T> Tagged<T>

pub fn metadata_id(&self) -> Option<Id>

This is supported on crate feature magic only.

Returns the ID of the metadata of the provider that sourced this value if it is known. As long self was extracted from a Figment, the returned value is expected to be Some.

The metadata can be retrieved by calling Figment::get_metadata() on the Figment self was extracted from.

Example

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

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

assert!(tagged.metadata_id().is_some());
assert!(figment.get_metadata(tagged.metadata_id().unwrap()).is_some());

pub fn into_inner(self) -> T

This is supported on crate feature magic only.

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> Clone for Tagged<T>

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> Debug for Tagged<T>

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

Formats the value using the given formatter.

impl<T> Deref for Tagged<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

fn from(value: T) -> Self

Performs the conversion.

impl<T: for<'de> Deserialize<'de>> Magic for Tagged<T>

const NAME: &'static str

const FIELDS: &'static [&'static str]

fn deserialize_from<'de: 'c, 'c, V: Visitor<'de>>(
    de: ConfiguredValueDe<'c>,
    visitor: V
) -> Result<V::Value, Error>

impl<T: PartialEq> PartialEq<Tagged<T>> for Tagged<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> Serialize for Tagged<T> where
    T: Serialize, 

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

Serialize this value into the given Serde serializer.