Struct hoard::config::Config

pub struct Config {
    pub command: Command,
    pub config_file: PathBuf,
    pub hoards: HashMap<HoardName, Hoard>,
    pub force: bool,
}

A (processed) configuration.

To create a configuration, use Builder instead.

Fields

command: Command

The command to run.

config_file: PathBuf

Path to a configuration file.

hoards: HashMap<HoardName, Hoard>

All of the configured hoards.

force: bool

Whether to force the operation to continue despite possible inconsistencies.

Implementations

impl Config

pub fn builder() -> Builder

Create a new Builder.

pub async fn load() -> Result<Self, Error>

Load a Config from CLI arguments and then configuration file.

Alias for Builder::from_args_then_file that then builds the builder into a Config.

Errors

The error returned by Builder::from_args_then_file, wrapped in Error::Builder.

pub fn get_config_file_path(&self) -> PathBuf

The path to the configured configuration file.

pub async fn run(&self) -> Result<(), Error>

Run the stored Command using this Config.

Errors

Any Error that might happen while running the command.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config