Trait ConfigurationSection

pub trait ConfigurationSection: Sized + DeserializeOwned {
    const PATH: Option<&'static str> = None;

    // Provided methods
    fn validate(&self, _figment: &Figment) -> Result<(), FigmentError> { ... }
    fn extract(figment: &Figment) -> Result<Self, FigmentError> { ... }
}

Trait implemented by all configuration section to help loading specific part of the config and generate the sample config.

Provided Associated Constants

const PATH: Option<&'static str> = None

Specify where this section should live relative to the root.

Provided Methods

fn validate(&self, _figment: &Figment) -> Result<(), FigmentError>

Validate the configuration section

Errors

Returns an error if the configuration is invalid

fn extract(figment: &Figment) -> Result<Self, FigmentError>

Extract configuration from a Figment instance.

Errors

Returns an error if the configuration could not be loaded

Object Safety

This trait is not object safe.

Implementors

impl ConfigurationSection for AccountConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for AppConfig

impl ConfigurationSection for BrandingConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for CaptchaConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for ClientsConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for DatabaseConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for EmailConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for ExperimentalConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for HttpConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for MatrixConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for PasswordsConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for PolicyConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for RateLimitingConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for RootConfig

impl ConfigurationSection for SecretsConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for SyncConfig

impl ConfigurationSection for TelemetryConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for TemplatesConfig

const PATH: Option<&'static str> = _

impl ConfigurationSection for UpstreamOAuth2Config

const PATH: Option<&'static str> = _