Struct PunktfSource

pub struct PunktfSource {
    pub root: PathBuf,
    pub profiles: PathBuf,
    pub dotfiles: PathBuf,
}

This struct represents the source directory used by punktf. The source directory is the central repository used to store Profiles and Dotfiles. punktf will only read data from these directories but never write to them.

The current structure looks something like this:

root/
+ profiles/
  ...
+ dotfiles/
  ...

Fields

root: PathBuf

The absolute root source path.

profiles: PathBuf

The absolute path to the profiles directory.

dotfiles: PathBuf

The absolute path to the dotfiles directory.

Implementations

impl PunktfSource

pub fn from_root(root: PathBuf) -> Result<Self>

Creates a instance from a root directory. During instantiation it checks if the root exists and is a directory. These checks will also be run for the root/profiles and root/dotfiles subdirectories. All the above mentioned paths will also be resolved by calling std::path::Path::canonicalize.

Errors

If any of the checks fail an error will be returned.

pub fn root(&self) -> &Path

Returns the absolute path for the root directory.

pub fn profiles(&self) -> &Path

Returns the absolute path to the root/profiles directory.

pub fn dotfiles(&self) -> &Path

Returns the absolute path to the root/dotfiles directory.

Trait Implementations

impl Clone for PunktfSource

fn clone(&self) -> PunktfSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PunktfSource

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

Formats the value using the given formatter.

impl PartialEq for PunktfSource

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

impl StructuralPartialEq for PunktfSource