Struct Profile

pub struct Profile {
    pub aliases: Vec<String>,
    pub extends: Vec<String>,
    pub variables: Option<Variables>,
    pub transformers: Vec<ContentTransformer>,
    pub target: Option<PathBuf>,
    pub pre_hooks: Vec<Hook>,
    pub post_hooks: Vec<Hook>,
    pub dotfiles: Vec<Dotfile>,
    pub symlinks: Vec<Symlink>,
}

A profile is a collection of dotfiles and variables, options and hooks.

Fields

aliases: Vec<String>

Aliases for this profile which can be used instead of the file name.

extends: Vec<String>

Defines the base profile. All settings from the base are merged with the current profile. The settings from the current profile take precedence. Dotfiles are merged on the dotfile level (not specific dotfile settings level).

variables: Option<Variables>

Variables of the profile. Each dotfile will have this environment.

transformers: Vec<ContentTransformer>

Content transform of the profile. Each dotfile will have these applied.

target: Option<PathBuf>

Target root path of the deployment. Will be used as file stem for the dotfiles when not overwritten by Dotfile::overwrite_target.

pre_hooks: Vec<Hook>

Hook will be executed once before the deployment begins. If the hook fails the deployment will not be continued.

post_hooks: Vec<Hook>

Hook will be executed once after the deployment begins.

dotfiles: Vec<Dotfile>

Dotfiles which will be deployed.

symlinks: Vec<Symlink>

Symlinks which will be deployed.

Implementations

impl Profile

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Tries to load a profile from the file located at path.

This function will try to guess the correct deserializer by the file extension of path

Errors

An error is returned if the file does not exist or could not be read. An error is returned if the file extension is unknown or missing.

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl Default for Profile

fn default() -> Profile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Profile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Profile

fn eq(&self, other: &Profile) -> 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 Profile

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 Profile

impl StructuralPartialEq for Profile