Struct Settings

pub struct Settings {
    pub daemon: DaemonSettings,
    pub reclustering: ReclusterSettings,
    pub tui: TuiSettings,
}

Fields

daemon: DaemonSettings

General Daemon Settings

reclustering: ReclusterSettings

Parameters for the reclustering algorithm.

tui: TuiSettings

Settings for the TUI

Implementations

impl Settings

pub fn init( config: PathBuf, port: Option<u16>, log_level: Option<LevelFilter>, ) -> Result<Self, ConfigError>

Load settings from the config file, environment variables, and CLI arguments.

The config file is located at the path specified by the --config flag.

The environment variables are prefixed with MECOMP_.

Arguments

• flags - The parsed CLI arguments.

Errors

This function will return an error if the config file is not found or if the config file is invalid.

pub fn get_config_path() -> Result<PathBuf, Error>

Get the (default) path to the config file. If the config file does not exist at this path, it will be created with the default config.

See crate::get_config_dir for more information about where this default path is located.

Errors

This function will return an error if the system config directory (e.g., ~/.config on linux) could not be found, or if the config file was missing and could not be created.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Settings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Settings

fn eq(&self, other: &Settings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Settings

impl StructuralPartialEq for Settings