Struct CreateAction

pub struct CreateAction<'a, F: FileSystem> { /* private fields */ }

CreateAction creates a new directory when executed

Implementations

impl<'a, F: FileSystem> CreateAction<'a, F>

pub fn directory(&self) -> &String

Directory to create. Can be absolute or relative.

pub fn create_parent_dirs(&self) -> &bool

Force creation of the directory and all its parents if they do not exist already.

Setting create_parent_dirs to true is equivalent to using the -p flag in mkdir.

pub fn current_dir(&self) -> &PathBuf

Current directory that will be used to determine relative file locations if necessary. It must match the parent directory of the configuration file that declared this action.

impl<'a, F: FileSystem> CreateAction<'a, F>

pub fn new( fs: &'a F, skip_in_ci: bool, directory: String, create_parent_dirs: bool, current_dir: PathBuf, ) -> Result<Self, DotfilesError>

Constructs a new instance of CreateAction

Trait Implementations

impl<F: FileSystem> Action<'_> for CreateAction<'_, F>

fn execute(&self) -> Result<(), DotfilesError>

Creates the directory.

Errors

• The parent directory does not exist and create_parent_dirs is false.
• There is already a directory, file or symlink with the same name.
• Permission denied.

impl<'a, F: FileSystem> ConditionalAction<'a> for CreateAction<'a, F>

fn skip_in_ci(&self) -> bool

Whether to skip this action in Continuous Integration environments.

fn check_conditions_and_execute(&self) -> Result<(), DotfilesError>

Checks that the conditions allow for executing this action, and if so executes it according to [execute(&self)].

impl<'a, F: FileSystem> Debug for CreateAction<'a, F>

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

Formats the value using the given formatter.

impl<'a, F: FileSystem> PartialEq for CreateAction<'a, F>

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