Struct lib::config::cli::Config

pub struct Config {
    pub verbose: bool,
    pub excludes: Vec<PathBuf>,
    pub tags: Vec<String>,
    pub dotfiles_path: Option<PathBuf>,
    pub hostname: Option<String>,
    pub command: Command,
}

Fields

verbose: bool

Enables verbose output.

excludes: Vec<PathBuf>

Paths (relative to the dotfiles folder) of items to be excluded. This is in addition to any excludes defined in your dotrc. Globs are accepted - just make sure to enclose them in single quotes to avoid your shell trying to expand them.

tags: Vec<String>

Tags to enable. This is in addition to any tags enabled in your dotrc.

dotfiles_path: Option<PathBuf>

The folder in which to search for dotfiles. The default is ~/.dotfiles.

hostname: Option<String>

The hostname to use. Only one hostname can be used. The default is the system hostname.

command: Command

Methods

impl Config

pub fn get() -> Self

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 StructOpt for Config

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.