Struct Settings 

pub struct Settings {
    pub log_level: String,
    pub overwrite: bool,
    pub debug_model: bool,
    pub results_root: PathBuf,
    pub graph_results_root: PathBuf,
}

Program settings from config file

NOTE: If you add or change a field in this struct, you must also update the schema in schemas/settings.yaml.

Fields

log_level: String

The default program log level

overwrite: bool

Whether to overwrite output files by default

debug_model: bool

Whether to write additional information to CSV files

results_root: PathBuf

Results root path to save MUSE2 results. Defaults to muse2_results.

graph_results_root: PathBuf

Results root path to save MUSE2 graph outputs. Defaults to muse2_graphs.

Implementations

impl Settings

pub fn load_or_default() -> Result<Settings>

Read the contents of a settings file from the global MUSE2 configuration directory.

If the file is not present or the user has set the MUSE2_USE_DEFAULT_SETTINGS environment variable to 1, then the default settings will be used.

Returns

The program settings as a Settings struct or an error if loading fails.

fn from_path_or_default(file_path: &Path) -> Result<Settings>

Try to read settings from the specified path, returning Settings::default() if it doesn’t exist

pub fn default_file_contents() -> String

The contents of the default settings file.

Trait Implementations

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

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

where Settings: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DocumentedFields for Settings

const FIELD_NAMES: &'static [&'static str]

Field names, as accepted by [Self::get_field_docs].

const FIELD_DOCS: &'static [&'static str]

The static doc comments on each field or variant of this type, indexed by field/variant order.

fn get_field_docs<T>(field_name: T) -> Result<&'static str, Error>

where T: AsRef<str>,

Get a field’s documentation using its name.

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 Serialize for Settings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Settings