Struct dotfiles_core::directive::DirectiveData

pub struct DirectiveData { /* private fields */ }

A struct that contains the default settings for a Directive and the name it takes in configuration sources. The name must be unique.

These default settings can be configured by the user as well.

Implementations

impl DirectiveData

pub fn name(&self) -> &String

Unique name of this directive.

This name will be used in configuration sources to instantiate actions of this directive

pub fn defaults(&self) -> &Settings

Default settings for this directive.

Any setting that is not in the defaults for a directive but is part of the corresponding Action struct is considered to be mandatory.

Since all configurable settings have a default, this can also be used to infer the data types.

impl DirectiveData

pub fn from(name: String, defaults: Settings) -> DirectiveData

Constructs a new directive from a name and a set of default settings.

pub fn parse_setting_value( &self, name: &str, yaml: &StrictYaml ) -> Result<Setting, DotfilesError>

DirectiveData.setting_types.

pub fn parse_context_defaults( &self, yaml_settings: &StrictYaml ) -> Result<Settings, DotfilesError>

Parses all settings for this directive from StrictYaml, checking the types correspond to what’s stored in DirectiveData.setting_types

Trait Implementations

impl Clone for DirectiveData

fn clone(&self) -> DirectiveData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectiveData

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

Formats the value using the given formatter.