Trait LoadConfig

pub trait LoadConfig {
    // Required method
    fn figment(&self) -> Figment;

    // Provided methods
    fn load_config(&self) -> Result<Config, ExtractConfigError> { ... }
    fn load_config_no_warnings(&self) -> Result<Config, ExtractConfigError> { ... }
    fn load_config_unsanitized(&self) -> Result<Config, ExtractConfigError> { ... }
    fn load_config_unsanitized_no_warnings(
        &self,
    ) -> Result<Config, ExtractConfigError> { ... }
    fn load_config_and_evm_opts(&self) -> Result<(Config, EvmOpts)> { ... }
    fn load_config_and_evm_opts_no_warnings(&self) -> Result<(Config, EvmOpts)> { ... }
}

Helpers for loading configuration.

This is usually implemented through the macros defined in [foundry_config]. See [foundry_config::impl_figment_convert] for more details.

By default each function will emit warnings generated during loading, unless the _no_warnings variant is used.

Required Methods

fn figment(&self) -> Figment

Load the [Config] based on the options provided in self.

Provided Methods

fn load_config(&self) -> Result<Config, ExtractConfigError>

Load and sanitize the [Config] based on the options provided in self.

fn load_config_no_warnings(&self) -> Result<Config, ExtractConfigError>

Same as LoadConfig::load_config but does not emit warnings.

fn load_config_unsanitized(&self) -> Result<Config, ExtractConfigError>

Load [Config] but do not sanitize. See [Config::sanitized] for more information.

fn load_config_unsanitized_no_warnings( &self, ) -> Result<Config, ExtractConfigError>

Same as LoadConfig::load_config_unsanitized but also emits warnings generated

fn load_config_and_evm_opts(&self) -> Result<(Config, EvmOpts)>

Load and sanitize the [Config], as well as extract [EvmOpts] from self

fn load_config_and_evm_opts_no_warnings(&self) -> Result<(Config, EvmOpts)>

Same as LoadConfig::load_config_and_evm_opts but also emits warnings generated

Implementors

impl<T> LoadConfig for T

where for<'a> Figment: From<&'a T>,