Skip to main content

ConfigCheck

Trait ConfigCheck 

Source
pub trait ConfigCheck: ConfigCheckRequirements {
    // Required method
    fn check_config<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        _cfg: &'life1 Config,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
}
Expand description

Trait for validating configuration before system initialization.

This trait is part of the composer pattern and allows composers to perform validation checks on the configuration before the datastore and network components are initialized. Implementations can verify that the configuration is valid for the specific backend and features being used.

Required Methods§

Source

fn check_config<'life0, 'life1, 'async_trait>( &'life0 mut self, _cfg: &'life1 Config, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Validates the provided configuration.

§Parameters
  • cfg: The configuration to validate
§Returns
  • Ok(()) if the configuration is valid
  • Err if the configuration is invalid or incompatible

Implementors§