Struct torrust_index_backend::config::Configuration

pub struct Configuration {
    pub settings: RwLock<TorrustBackend>,
    pub config_path: Option<String>,
}

The configuration service.

Fields

settings: RwLock<TorrustBackend>

The state of the configuration.

config_path: Option<String>

The path to the configuration file. This is None if the configuration was loaded from the environment.

Implementations

impl Configuration

pub async fn load_from_file( config_path: &str ) -> Result<Configuration, ConfigError>

Loads the configuration from the configuration file.

Errors

This function will return an error no configuration in the CONFIG_PATH exists, and a new file is is created. This function will return an error if the config is not a valid TorrustConfig document.

pub fn load_from_env_var( config_env_var_name: &str ) -> Result<Configuration, ConfigError>

Loads the configuration from the environment variable. The whole configuration must be in the environment variable. It contains the same configuration as the configuration file with the same format.

Errors

Will return Err if the environment variable does not exist or has a bad configuration.

pub async fn save_to_file(&self, config_path: &str)

Returns the save to file of this Configuration.

pub async fn update_settings( &self, new_settings: TorrustBackend ) -> Result<(), ()>

Update the settings file based upon a supplied new_settings.

Errors

Todo: Make an error if the save fails.

Panics

Will panic if the configuration file path is not defined. That happens when the configuration was loaded from the environment variable.

pub async fn get_all(&self) -> TorrustBackend

pub async fn get_public(&self) -> ConfigurationPublic

pub async fn get_site_name(&self) -> String

pub async fn get_api_base_url(&self) -> Option<String>

Trait Implementations

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Configuration

Returns the “default value” for a type.