lib::config::cli

Struct 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 platform: Option<Platform>,
    pub command: Command,
}

Expand description

The portion of the configuration read from CLI arguments

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. The default is the system hostname.

§platform: Option<Platform>

The platform to use. The default is the actual platform. Valid values are macos, windows, linux, and wsl.

§command: Command

Implementations§

impl Config

pub fn get() -> Self

Trait Implementations§

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Config

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Config

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.