Struct pueue_lib::settings::Settings

pub struct Settings {
    pub client: Client,
    pub daemon: Daemon,
    pub shared: Shared,
    pub profiles: HashMap<String, NestedSettings>,
}

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

Fields

client: Client

daemon: Daemon

shared: Shared

profiles: HashMap<String, NestedSettings>

Implementations

impl Settings

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

Try to read existing config files, while using default values for non-existing fields. If successful, this will return a full config as well as a boolean on whether we found an existing configuration file or not.

The default local config locations depends on the current target.

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

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.

pub fn load_profile(&mut self, profile: &str) -> Result<(), Error>

Try to load a profile. Error if it doesn’t exist.

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() -> Self

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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 Eq for Settings

impl StructuralEq for Settings

impl StructuralPartialEq for Settings