Struct GenericConfiguration 

pub struct GenericConfiguration { /* private fields */ }

A generic configuration object.

This represents the merged configuration derived from ConfigurationLoader in its raw form. Values can be queried by key, and can be extracted either as typed values or in their raw form.

Keys must be in the form of a.b.c, where periods (.) as used to indicate a nested value.

Using an example JSON configuration:

{
  "a": {
    "b": {
      "c": "value"
    }
  }
}

Querying for the value of a.b.c would return "value", and querying for a.b would return the nested object { "c": "value" }.

Implementations

impl GenericConfiguration

pub async fn ready(&self)

Waits for the configuration to be ready, if dynamic configuration is enabled.

If dynamic configuration is in use, this method will asynchronously wait until the first snapshot has been received and applied.

If dynamic configuration is not used, it returns immediately.

pub fn get_typed<'a, T>(&self, key: &str) -> Result<T, ConfigurationError>

where T: Deserialize<'a>,

Gets a configuration value by key.

The key must be in the form of a.b.c, where periods (.) are used to indicate a nested lookup.

Errors

If the key does not exist in the configuration, or if the value could not be deserialized into T, an error variant will be returned.

pub fn get_typed_or_default<'a, T>(&self, key: &str) -> T

where T: Default + Deserialize<'a>,

Gets a configuration value by key, or the default value if a key does not exist or could not be deserialized.

The Default implementation of T will be used both if the key could not be found, as well as for any error during deserialization. This effectively swallows any errors and should generally be used sparingly.

The key must be in the form of a.b.c, where periods (.) are used to indicate a nested lookup.

pub fn try_get_typed<'a, T>( &self, key: &str, ) -> Result<Option<T>, ConfigurationError>

where T: Deserialize<'a>,

Gets a configuration value by key, if it exists.

If the key exists in the configuration, and can be deserialized, Ok(Some(value)) is returned. Otherwise, Ok(None) will be returned.

The key must be in the form of a.b.c, where periods (.) are used to indicate a nested lookup.

Errors

If the value could not be deserialized into T, an error will be returned.

pub fn as_typed<'a, T>(&self) -> Result<T, ConfigurationError>

where T: Deserialize<'a>,

Attempts to deserialize the entire configuration as T.

Errors

If the value could not be deserialized into T, an error will be returned.

pub fn subscribe_for_updates(&self) -> Option<Receiver<ConfigChangeEvent>>

Subscribes for updates to the configuration.

pub fn watch_for_updates(&self, key: &str) -> FieldUpdateWatcher

Creates a watcher that yields only when the given key changes.

If dynamic configuration is disabled, the returned watcher’s changed() will wait indefinitely.

Trait Implementations

impl Clone for GenericConfiguration

fn clone(&self) -> GenericConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericConfiguration

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

Formats the value using the given formatter.