Struct ReloadableConfiguration 

pub struct ReloadableConfiguration(/* private fields */);

Represents a reloadable configuration.

Implementations

impl ReloadableConfiguration

pub fn new(builder: Builder, configuration: Configuration) -> Self

Initializes a new ReloadableConfiguration.

Arguments

• builder - The builder used to reload the configuration
• config - The initial configuration

pub fn current(&self) -> Arc<Configuration>

Gets the current configuration.

Remarks

This method will reload the configuration if it has changed. If the reload operation fails, then the error is logged and the previous configuration is retained.

impl ReloadableConfiguration

pub fn reify<T: DeserializeOwned>(&self) -> Result<T>

Available on crate feature binder only.

Creates and returns a structure reified from the configuration.

pub fn bind<T: DeserializeOwned>(&self, instance: &mut T) -> Result

Available on crate feature binder only.

Binds the configuration to the specified instance.

Arguments

• instance - The instance to bind the configuration to

pub fn bind_at<T: DeserializeOwned>( &self, key: impl AsRef<str>, instance: &mut T, ) -> Result

Available on crate feature binder only.

Binds the specified configuration section to the provided instance.

Arguments

• key - The key of the configuration section to bind
• instance - The instance to bind the configuration to

pub fn get_value<T: FromStr>( &self, key: impl AsRef<str>, ) -> Result<Option<T>, T::Err>

Available on crate feature binder only.

Gets a typed value from the configuration.

Arguments

• key - The key of the value to retrieve

pub fn get_value_or_default<T: FromStr + Default>( &self, key: impl AsRef<str>, ) -> Result<T, T::Err>

Available on crate feature binder only.

Gets an optional, typed value from the configuration.

Arguments

• key - The key of the value to retrieve

Trait Implementations

impl Binder for ReloadableConfiguration

Available on crate feature binder only.

fn reify<T: DeserializeOwned>(&self) -> Result<T>

Creates and returns a structure reified from the configuration.

fn bind<T: DeserializeOwned>(&self, instance: &mut T) -> Result

Binds the configuration to the specified instance.

fn bind_at<T: DeserializeOwned>( &self, key: impl AsRef<str>, instance: &mut T, ) -> Result

Binds the specified configuration section to the provided instance.

fn get_value<T: FromStr>( &self, key: impl AsRef<str>, ) -> Result<Option<T>, T::Err>

Gets a typed value from the configuration.

fn get_value_or_default<T: FromStr + Default>( &self, key: impl AsRef<str>, ) -> Result<T, T::Err>

Gets an optional, typed value from the configuration.

fn reify_unchecked<T: DeserializeOwned>(&self) -> T

Creates and returns a structure reified from the configuration.

fn bind_unchecked<T: DeserializeOwned>(&self, instance: &mut T)

Binds the configuration to the specified instance.

fn bind_at_unchecked<T: DeserializeOwned>( &self, key: impl AsRef<str>, instance: &mut T, )

Binds the specified configuration section to the provided instance.

impl Clone for ReloadableConfiguration

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReloadableConfiguration

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

Formats the value using the given formatter.

impl Display for ReloadableConfiguration

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

Formats the value using the given formatter.

impl From<&ReloadableConfiguration> for Arc<Configuration>

fn from(rc: &ReloadableConfiguration) -> Self

Converts to this type from the input type.

impl From<ReloadableConfiguration> for Arc<Configuration>

fn from(rc: ReloadableConfiguration) -> Self

Converts to this type from the input type.

impl Reloadable for ReloadableConfiguration

fn can_reload(&self) -> bool

Gets a value indicating whether the configuration can be reloaded.

fn reload_token(&self) -> impl ChangeToken + 'static

Gets a change token that will be notified when the configuration is reloaded.

impl TryFrom<Builder> for ReloadableConfiguration

type Error = Error

The type returned in the event of a conversion error.

fn try_from(builder: Builder) -> Result<Self>

Performs the conversion.