figment2 0.11.5

Remaintained fork of figment: A configuration library so con-free, it's unreal.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use std::borrow::Cow;

use crate::*;

/// Wrap a [`Provider`], giving it a new name.
///
/// ```
/// use clap::Parser;
/// use figment2::*;
/// # use serde::*;
/// # fn tri() -> Result<()> {
///
/// #[derive(Parser, Serialize, Deserialize)]
/// struct Cli {
///     #[arg(long)]
///     num_yaks: Option<usize>,
/// }
///
/// let cli = Cli::parse();
///
/// # let _: serde::de::IgnoredAny =
/// Figment::new()
///     // ...
///     .merge(providers::Named::new(
///         "cli arguments",
///         providers::Serialized::defaults(cli)
///     ))
///     .extract()?;
/// # Ok(()) }
/// ```
#[derive(Debug, Clone)]
pub struct Named<T> {
    name: Cow<'static, str>,
    provider: T,
}

impl<T> Named<T> {
    /// Wrap a [`Provider`], giving it a new name.
    pub fn new(name: impl Into<Cow<'static, str>>, provider: T) -> Self {
        Self { name: name.into(), provider }
    }
}

impl<T: Provider> Provider for Named<T> {
    fn metadata(&self) -> Metadata {
        let mut meta = self.provider.metadata();
        meta.name.clone_from(&self.name);
        meta
    }
    fn data(&self) -> Result<value::Map<Profile, value::Dict>> {
        self.provider.data()
    }
    fn profile(&self) -> Option<Profile> {
        self.provider.profile()
    }
    fn __metadata_map(&self) -> Option<value::Map<value::Tag, Metadata>> {
        self.provider.__metadata_map()
    }
}