Struct Deployer 

pub struct Deployer<F> { /* private fields */ }

Responsible for deploying a profile.

This includes checking for merge conflicts, resolving children of a directory dotfile, parsing and resolving of templates and the actual writing of the dotfile to the target destination.

Implementations

impl<F> Deployer<F>

where F: Fn(&Path, &Path) -> Result<bool>,

pub fn new(options: DeployOptions, merge_ask_fn: F) -> Self

Creates a new instance.

pub fn into_deployment(self) -> Deployment

Retrieves the finished deployment from this instance.

pub fn deploy( self, source: &PunktfSource, profile: &mut LayeredProfile, ) -> Deployment

Tries to deploy the given profile.

Errors

Only hard errors will be returned as error, everything else will be recorded in the Deployment on a dotfile level.

Trait Implementations

impl<F: Clone> Clone for Deployer<F>

fn clone(&self) -> Deployer<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for Deployer<F>

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

Formats the value using the given formatter.

impl<F: Eq> Eq for Deployer<F>

impl<F: PartialEq> PartialEq for Deployer<F>

fn eq(&self, other: &Deployer<F>) -> 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<F> StructuralPartialEq for Deployer<F>

impl<F> TemplateVisitor for Deployer<F>

where F: Fn(&Path, &Path) -> Result<bool>,

fn accept_template<'a>( &mut self, _: &PunktfSource, profile: &LayeredProfile, file: &File<'a>, resolve_content: impl FnOnce(&str) -> Result<String>, ) -> Result

Accepts a file template item and tries to deploy it.

Before the deployment the template is parsed and resolved.

impl<F> Visitor for Deployer<F>

where F: Fn(&Path, &Path) -> Result<bool>,

fn accept_file<'a>( &mut self, _: &PunktfSource, profile: &LayeredProfile, file: &File<'a>, ) -> Result

Accepts a file item and tries to deploy it.

fn accept_directory<'a>( &mut self, _: &PunktfSource, _: &LayeredProfile, directory: &Directory<'a>, ) -> Result

Accepts a directory item and tries to deploy it.

fn accept_link( &mut self, _: &PunktfSource, _: &LayeredProfile, link: &Symlink, ) -> Result

Accepts a link item and tries to deploy it.

fn accept_rejected<'a>( &mut self, _: &PunktfSource, _: &LayeredProfile, rejected: &Rejected<'a>, ) -> Result

Accepts a rejected item and reports it.

fn accept_errored<'a>( &mut self, _: &PunktfSource, _: &LayeredProfile, errored: &Errored<'a>, ) -> Result

Accepts a errored item and reports it.