GlobalConfig

Struct GlobalConfig 

Source
pub struct GlobalConfig {
    pub staging: StagingPath,
    pub method: SyncMethod,
    pub subgroup_prefix: SubgroupPrefix,
    pub allow_overwrite: AllowOverwrite,
    pub ignore_failure: IgnoreFailure,
    pub renderable: Renderable,
    pub hostname_sep: HostnameSeparator,
    pub rename: RenamingRules,
}
Expand description

Configures default behaviours.

Fields§

§staging: StagingPath

The staging root directory.

Only works when method (see below) is set to Symlink. When syncing with Symlink method, items will be copied to their staging directory (composed by joining staging root directory with their group name), then symlinked (as of ln -sf) from their staging directory to the target directory.

Default to $XDG_DATA_HOME/dt/staging if XDG_DATA_HOME is set, or $HOME/.cache/dt/staging if HOME is set. Panics when neither XDG_DATA_HOME nor HOME is set and config file does not specify this.

§method: SyncMethod

The syncing method.

Available values are:

When method is Copy, the above staging setting will be disabled.

§subgroup_prefix: SubgroupPrefix

A string to be prepended to a subgroup’s name when creating its staging directory with the Symlink syncing method.

§allow_overwrite: AllowOverwrite

Whether to allow overwriting existing files.

This alters syncing behaviours when the target file exists. If set to true, no errors/warnings will be omitted when the target file exists; otherwise reports error and skips the existing item. Using dry run to spot the existing files before syncing is recommended.

§ignore_failure: IgnoreFailure

Whether to treat errors omitted during syncing as warnings. It has a per-group counterpart to set per-group behaviours. Note that errors occurred before or after syncing are NOT affected.

§renderable: Renderable

Whether to enable templating. It has a per-group counterpart to set if a group is to be rendered.

§hostname_sep: HostnameSeparator

The hostname separator.

Specifies default value when Group::hostname_sep is not set.

§rename: RenamingRules

Global item renaming rules.

Rules defined here will be prepended to renaming rules of each group. See Group::rename.

Trait Implementations§

Source§

impl Clone for GlobalConfig

Source§

fn clone(&self) -> GlobalConfig

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
Source§

impl Debug for GlobalConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GlobalConfig

Source§

fn default() -> GlobalConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GlobalConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,