Struct LinkDirective

pub struct LinkDirective<'a, F: FileSystem + UnixFileSystem + Default> { /* private fields */ }

A directive that can build LinkActions to create directories in the filesystem.

Implementations

impl<'a, F: FileSystem + UnixFileSystem + Default> LinkDirective<'a, F>

where LinkDirective<'a, F>: HasDirectiveData<'a> + Directive<'a>,

pub fn fs(&self) -> &F

Returns the [FileSystem] instance being used.

pub fn parse_shortened_action( &'a self, context_settings: &Settings, yaml: &StrictYaml, current_dir: &Path, ) -> Result<LinkAction<'a, F>, DotfilesError>

Parse a shortened action with only link name to target name

Trait Implementations

impl<'a, F: FileSystem + UnixFileSystem + Default> ActionParser<'a> for LinkDirective<'a, F>

type ActionType = LinkAction<'a, F>

The action type this object parses

fn parse_action( &'a self, settings: &Settings, yaml: &StrictYaml, current_directory: &Path, ) -> Result<LinkAction<'a, F>, DotfilesError>

Builds a single action of type [ActionParser::ActionType] from StrictYaml tree object that represents the action’s configuration and a default settings object.

fn parse_action_list( &'a self, settings: &HashMap<String, Setting>, yaml: &StrictYaml, current_dir: &Path, ) -> Result<Vec<Self::ActionType>, DotfilesError>

Builds a list of actions of type [ActionParser::ActionType] from StrictYaml tree object that represents the actions’ configurations and a default settings object.

impl<'a, F: Clone + FileSystem + UnixFileSystem + Default> Clone for LinkDirective<'a, F>

fn clone(&self) -> LinkDirective<'a, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, F: FileSystem + UnixFileSystem + Default> Default for LinkDirective<'a, F>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, F: FileSystem + UnixFileSystem + Default> Directive<'a> for LinkDirective<'a, F>

fn get_setting_from_yaml_hash_or_from_context( &'a self, name: &str, yaml: &StrictYaml, context_settings: &HashMap<String, Setting>, ) -> Result<Setting, DotfilesError>

Parse a particular setting with its correct type from yaml, fall back to context settings or directive defaults if not found in yaml. Returns error if there is any kind of parsing or typing error

fn get_setting_from_yaml_hash( &'a self, name: &str, yaml: &StrictYaml, ) -> Result<Setting, DotfilesError>

Parses an individual setting named name from a yaml hash using the type stored in DirectiveData.setting_types.

impl<'a, F: FileSystem + UnixFileSystem + Default> FileSystemDirective<'a, F> for LinkDirective<'a, F>

fn fs(&self) -> &F

Returns the filesystem instance

fn mut_fs(&mut self) -> &mut F

Returns a mutable reference to the filesystem instance

impl<'a, F: FileSystem + UnixFileSystem + Default> HasDirectiveData<'a> for LinkDirective<'a, F>

fn directive_data(&'a self) -> &'a DirectiveData

Returns the directive data for this object

fn name(&'a self) -> &'a str

Returns the name of the directive.

fn defaults(&'a self) -> &'a HashMap<String, Setting>

Returns the default settings as configured.