Trait confik::Configuration

pub trait Configuration: Sized {
    type Builder: ConfigurationBuilder<Target = Self>;

    // Provided method
    fn builder<'a>() -> ConfigBuilder<'a, Self> { ... }
}

The target to be deserialized from multiple sources.

This will normally be created by the derive macro which also creates a ConfigurationBuilder implementation.

For types with no contents, e.g. empty structs, or simple enums, this can be implemented very easily by specifying only the builder type as Option<Self>. For anything more complicated, complete target and builder implementations will be needed.

Examples

use confik::Configuration;

#[derive(serde::Deserialize)]
enum MyEnum { A, B, C }

impl Configuration for MyEnum {
    type Builder = Option<Self>;
}

Required Associated Types

type Builder: ConfigurationBuilder<Target = Self>

The builder that accumulates the deserializations.

Provided Methods

fn builder<'a>() -> ConfigBuilder<'a, Self>

Creates an instance of ConfigBuilder tied to this type.

Examples found in repository

examples/defaulting.rs (line 25)

fn main() {
    let config = Config::builder()
        .try_build()
        .expect("Failed to parse config");

    assert_eq!(
        config,
        Config {
            field1: 5,
            field2: String::from("Hello World"),
            data: Data {
                elements: vec![4, 3, 2, 1],
            },
        }
    );
}

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Configuration for IpAddr

type Builder = Option<IpAddr>

impl Configuration for SocketAddr

type Builder = Option<SocketAddr>

impl Configuration for IpNetwork

Available on crate feature ipnetwork only.

type Builder = Option<IpNetwork>

impl Configuration for bool

type Builder = Option<bool>

impl Configuration for char

type Builder = Option<char>

impl Configuration for f32

type Builder = Option<f32>

impl Configuration for f64

type Builder = Option<f64>

impl Configuration for i8

type Builder = Option<i8>

impl Configuration for i16

type Builder = Option<i16>

impl Configuration for i32

type Builder = Option<i32>

impl Configuration for i64

type Builder = Option<i64>

impl Configuration for i128

type Builder = Option<i128>

impl Configuration for isize

type Builder = Option<isize>

impl Configuration for u8

type Builder = Option<u8>

impl Configuration for u16

type Builder = Option<u16>

impl Configuration for u32

type Builder = Option<u32>

impl Configuration for u64

type Builder = Option<u64>

impl Configuration for u128

type Builder = Option<u128>

impl Configuration for usize

type Builder = Option<usize>

impl Configuration for String

type Builder = Option<String>

impl Configuration for Ipv4Addr

type Builder = Option<Ipv4Addr>

impl Configuration for Ipv6Addr

type Builder = Option<Ipv6Addr>

impl Configuration for SocketAddrV4

type Builder = Option<SocketAddrV4>

impl Configuration for SocketAddrV6

type Builder = Option<SocketAddrV6>

impl Configuration for Duration

type Builder = Option<Duration>

impl Configuration for OsString

type Builder = Option<OsString>

impl Configuration for PathBuf

type Builder = Option<PathBuf>

impl Configuration for SystemTime

type Builder = Option<SystemTime>

impl Configuration for BigDecimal

Available on crate feature bigdecimal only.

type Builder = Option<BigDecimal>

impl Configuration for ByteSize

Available on crate feature bytesize only.

type Builder = Option<ByteSize>

impl Configuration for Utf8PathBuf

Available on crate feature camino only.

type Builder = Option<Utf8PathBuf>

impl Configuration for NaiveDate

Available on crate feature chrono only.

type Builder = Option<NaiveDate>

impl Configuration for NaiveTime

Available on crate feature chrono only.

type Builder = Option<NaiveTime>

impl Configuration for Decimal

Available on crate feature rust_decimal only.

type Builder = Option<Decimal>

impl Configuration for Url

Available on crate feature url only.

type Builder = Option<Url>

impl Configuration for Uuid

Available on crate feature uuid only.

type Builder = Option<Uuid>

impl Configuration for SecretString

Available on crate feature secrecy only.

type Builder = SecretOption<Secret<String>>

impl<K, V> Configuration for BTreeMap<K, V>

where K: Ord + Display + DeserializeOwned + 'static, V: Configuration, <V as Configuration>::Builder: 'static,

type Builder = KeyedContainerBuilder<BTreeMap<K, <V as Configuration>::Builder>, BTreeMap<K, V>>

impl<K, V, S> Configuration for HashMap<K, V, S>

where K: Hash + Eq + Display + DeserializeOwned + 'static, V: Configuration, <V as Configuration>::Builder: 'static, S: Default + BuildHasher + 'static,

type Builder = KeyedContainerBuilder<HashMap<K, <V as Configuration>::Builder, S>, HashMap<K, V, S>>

impl<T> Configuration for BTreeSet<T>

where T: Configuration + Ord, <T as Configuration>::Builder: Ord + 'static,

type Builder = UnkeyedContainerBuilder<BTreeSet<<T as Configuration>::Builder>, BTreeSet<T>>

impl<T> Configuration for Vec<T>

where T: Configuration, <T as Configuration>::Builder: 'static,

type Builder = UnkeyedContainerBuilder<Vec<<T as Configuration>::Builder>, Vec<T>>

impl<T> Configuration for PhantomData<T>

PhantomData does not need a builder, however we cannot use () as that would make T unconstrained. Instead just making it use itself as a builder and rely on serde handling it alright.

type Builder = PhantomData<T>

impl<T, S> Configuration for HashSet<T, S>

where T: Configuration + Eq + Hash, <T as Configuration>::Builder: Hash + Eq + 'static, S: BuildHasher + Default + 'static,

type Builder = UnkeyedContainerBuilder<HashSet<<T as Configuration>::Builder, S>, HashSet<T, S>>

impl<T, const N: usize> Configuration for [T; N]

where [<T as Configuration>::Builder; N]: DeserializeOwned + Default, T: Configuration,

type Builder = [<T as Configuration>::Builder; N]

impl<T: TimeZone> Configuration for DateTime<T>

where Self: DeserializeOwned,

Available on crate feature chrono only.

type Builder = Option<DateTime<T>>

impl<T: Configuration> Configuration for Option<T>

where OptionBuilder<<T as Configuration>::Builder>: DeserializeOwned,

Build an Option<T> with a custom structure as we want None to be an explicit value that will not be overwritten.

type Builder = OptionBuilder<<T as Configuration>::Builder>

Implementors

impl Configuration for DatabaseConnectionConfig

Available on crate feature common only.

type Builder = DatabaseConnectionConfigConfigBuilder