Struct dt_core::config::LocalSyncConfig

pub struct LocalSyncConfig {
    pub name: String,
    pub hostname_sep: Option<String>,
    pub basedir: PathBuf,
    pub sources: Vec<PathBuf>,
    pub target: PathBuf,
    pub ignored: Option<Vec<String>>,
    pub allow_overwrite: Option<bool>,
    pub method: Option<SyncMethod>,
}

Configures how local items (files/directories) are synced.

Fields

name: String

Name of this group, used as namespaces when staging.

hostname_sep: Option<String>

Separator for per-host settings, default to “@@”.

Note: All items with names contains this separator will be ignored.

An additional item with ${hostname_sep}$(hostname) appended to the original item name will be checked first, before looking for the original item. If the appended item is found, use this item instead of the configured one.

Example

When the following directory structure exists:

~/.ssh/
├── authorized_keys
├── authorized_keys@@sherlock
├── authorized_keys@@watson
├── config
├── config@sherlock
└── config@watson

On a machine with hostname set to watson, the below configuration (extraneous keys are omitted here)

...
hostname_sep = "@@"

basedir = "~/.ssh"
sources = ["config"]
target = "/tmp/sshconfig"
...

will result in the below target (/tmp/sshconfig):

/tmp/sshconfig/
└── config

Where /tmp/sshconfig/config mirrors the content of ~/.ssh/config@watson.

basedir: PathBuf

The base directory of all source items. This simplifies configuration files with common prefixes in local.sources array.

Example

For a directory structure like:

dt/
├── dt-core/
│  └── src/
│     └── config.rs
├── dt-cli/
│  └── src/
│     └── main.rs
└── README.md

Consider the following config file:

[[local]]
basedir = "dt/dt-cli"
sources = ["*"]
target = "."

It will only sync src/main.rs to the configured target directory (in this case, the directory where dt is being executed).

sources: Vec<PathBuf>

Paths (relative to basedir) to the items to be synced.

target: PathBuf

The absolute path of the parent dir of the final synced items.

Example

source = ["/source/file"]
target = "/tar/get"

will sync “/source/file” to “/tar/get/file” (creating non-existing directories along the way), while

source = ["/source/dir"]
target = "/tar/get/dir"

will sync “source/dir” to “/tar/get/dir/dir” (creating non-existing directories along the way).

ignored: Option<Vec<String>>

(Optional) Ignored names.

Example

Consider the following ignored setting:

ignored = [".git"]

With this setting, all files or directories with their basename as “.git” will be skipped.

Cannot contain slash in any of the patterns.

allow_overwrite: Option<bool>

(Optional) Whether to allow overwriting existing files. Dead symlinks are treated as non-existing, and are always overwrited (regardless of this option).

method: Option<SyncMethod>

(Optional) Syncing method, overrides global.method key.

Implementations

impl LocalSyncConfig

pub fn get_allow_overwrite(&self, global_config: &GlobalConfig) -> bool

Gets the allow_overwrite key from a LocalSyncConfig object, falls back to the allow_overwrite from provided global config.

pub fn get_method(&self, global_config: &GlobalConfig) -> SyncMethod

Gets the method key from a LocalSyncConfig object, falls back to the method from provided global config.

pub fn get_hostname_sep(&self, global_config: &GlobalConfig) -> String

Gets the method key from a LocalSyncConfig object, falls back to the method from provided global config.

Trait Implementations

impl Clone for LocalSyncConfig

fn clone(&self) -> LocalSyncConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalSyncConfig

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

Formats the value using the given formatter.

impl Default for LocalSyncConfig

fn default() -> LocalSyncConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalSyncConfig

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

Deserialize this value from the given Serde deserializer.