Struct config::Config

pub struct Config {
    pub cache: Value,
    // some fields omitted
}

A prioritized configuration repository. It maintains a set of configuration sources, fetches values to populate those, and provides them according to the source’s priority.

Fields

cache: Value

Root of the cached configuration.

Implementations

impl Config

pub fn new() -> Self

pub fn merge<T>(&mut self, source: T) -> Result<&mut Config, ConfigError> where
    T: 'static,
    T: Source + Send + Sync, 

Merge in a configuration property source.

pub fn with_merged<T>(self, source: T) -> Result<Self, ConfigError> where
    T: 'static,
    T: Source + Send + Sync, 

Merge in a configuration property source.

pub fn refresh(&mut self) -> Result<&mut Config, ConfigError>

Refresh the configuration cache with fresh data from added sources.

Configuration is automatically refreshed after a mutation operation (set, merge, set_default, etc.).

pub fn set_default<T>(
    &mut self,
    key: &str,
    value: T
) -> Result<&mut Config, ConfigError> where
    T: Into<Value>, 

pub fn set<T>(
    &mut self,
    key: &str,
    value: T
) -> Result<&mut Config, ConfigError> where
    T: Into<Value>, 

pub fn set_once(&mut self, key: &str, value: Value) -> Result<(), ConfigError>

pub fn get<'de, T: Deserialize<'de>>(&self, key: &str) -> Result<T, ConfigError>

pub fn get_str(&self, key: &str) -> Result<String, ConfigError>

pub fn get_int(&self, key: &str) -> Result<i64, ConfigError>

pub fn get_float(&self, key: &str) -> Result<f64, ConfigError>

pub fn get_bool(&self, key: &str) -> Result<bool, ConfigError>

pub fn get_table(
    &self,
    key: &str
) -> Result<HashMap<String, Value>, ConfigError>

pub fn get_array(&self, key: &str) -> Result<Vec<Value>, ConfigError>

pub fn try_into<'de, T: Deserialize<'de>>(self) -> Result<T, ConfigError>

Attempt to deserialize the entire configuration into the requested type.

pub fn try_from<T: Serialize>(from: &T) -> Result<Self, ConfigError>

Attempt to serialize the entire configuration from the given type.

pub fn deserialize<'de, T: Deserialize<'de>>(self) -> Result<T, ConfigError>

👎 Deprecated since 0.7.0:

please use ‘try_into’ instead

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserializer<'de> for Config

type Error = ConfigError

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, ConfigError> where
    V: Visitor<'de>, 

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_bool<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_f32<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_str<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V: Visitor<'de>>(
    self,
    visitor: V
) -> Result<V::Value, ConfigError>

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, ConfigError> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

fn deserialize_enum<V>(
    self,
    name: &'static str,
    variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, ConfigError> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a char value.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit value.

fn deserialize_newtype_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn deserialize_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_tuple_struct<V>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_i128<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl Source for Config

fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>

fn collect(&self) -> Result<HashMap<String, Value>, ConfigError>

Collect all configuration properties available from this source and return a HashMap.

fn collect_to(&self, cache: &mut Value) -> Result<(), ConfigError>