Struct Dotfile

pub struct Dotfile {
    pub path: PathBuf,
    pub rename: Option<PathBuf>,
    pub overwrite_target: Option<PathBuf>,
    pub priority: Option<Priority>,
    pub variables: Option<Variables>,
    pub transformers: Vec<ContentTransformer>,
    pub merge: Option<MergeMode>,
    pub template: Option<bool>,
}

A dotfile represents a single item to be deployed by punktf. This can either be a single file or a directory. This struct holds attributes to control how the item will be deployed.

Fields

path: PathBuf

Relative path inside the PunktfSource::dotfiles directory.

rename: Option<PathBuf>

Alternative relative name/path for the dotfile. This name will be used instead of Dotfile::path when deploying. If this is set and the dotfile is a directory, it will be deployed under the given name and not in the PunktfSource::root directory.

overwrite_target: Option<PathBuf>

Alternative absolute deploy target path. This will be used instead of Profile::target when deploying.

priority: Option<Priority>

Priority of the dotfile. Dotfiles with higher priority as others are allowed to overwrite an already deployed dotfile if the Dotfile::merge allows for it.

variables: Option<Variables>

Variables specifically defined for this dotfile. These variables will take precedence over the ones defined in Profile::variables.

transformers: Vec<ContentTransformer>

Content transform defined for the dotfile. These variables will take precedence over the ones defined in profile::Profile::transformers.

merge: Option<MergeMode>

Merge operation for already existing dotfiles with the same or higher priority.

template: Option<bool>

Indicates if the dotfile should be treated as a template. If this is false no template processing will be done.

Implementations

impl Dotfile

pub fn is_template(&self) -> bool

Checks if the dotfile is considered to be a template.

Trait Implementations

impl Clone for Dotfile

fn clone(&self) -> Dotfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dotfile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dotfile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Dotfile

fn eq(&self, other: &Dotfile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Dotfile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Dotfile

impl StructuralPartialEq for Dotfile