Struct pueue_lib::settings::Settings

pub struct Settings {
    pub client: Client,
    pub daemon: Daemon,
    pub shared: Shared,
}

The parent settings struct.
This contains all other setting structs.

Fields

client: Client

daemon: Daemon

shared: Shared

Implementations

impl Settings

pub fn new(
    require_config: bool,
    from_file: &Option<PathBuf>
) -> Result<Settings>

This function creates a new configuration instance and populates it with default values for every option.
If a local config file already exists, it is parsed and overrules the default option values. The default local config is located at "~/.config/pueue.yml".

If require_config is true, an error will be thrown, if no configuration file can be found. This is utilized by the client, since only the daemon is allowed to touch the configuration file.

pub fn default_config() -> Result<Config>

pub fn read(
    require_config: bool,
    from_file: &Option<PathBuf>
) -> Result<Settings>

Try to read the config file without any default values. This is done by the daemon on startup. If the file can be read without any need for defaults, we don't have to persist it afterwards.

pub fn save(&self, path: &Option<PathBuf>) -> Result<()>

Save the current configuration as a file to the given path.
If no path is given, the default configuration path will be used.
The file is then written to the main configuration directory of the respective OS.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

pub 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<'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 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.