Trait ConfigSource

pub trait ConfigSource: Send {
    // Required methods
    fn name(&self) -> &str;
    fn load(
        &self,
        builder: &mut ConfigSourceBuilder<'_>,
    ) -> Result<(), ConfigError>;

    // Provided methods
    fn allow_refresh(&self) -> bool { ... }
    fn refreshable(&self) -> Result<bool, ConfigError> { ... }
}

Config source.

Config source examples:

• Load from programming.
• Load from environment.
• Load from file.
• Load from network.
• …

Required Methods

fn name(&self) -> &str

Config source name.

fn load(&self, builder: &mut ConfigSourceBuilder<'_>) -> Result<(), ConfigError>

Load config source.

Provided Methods

fn allow_refresh(&self) -> bool

If this config source can be refreshed.

fn refreshable(&self) -> Result<bool, ConfigError>

Check if config source is refreshable.

Implementor should notice that everytime this method is called, the refreshable state must be reset to false.

Implementors