Struct mammoth_setup::config::module::Module

pub struct Module { /* fields omitted */ }

Structure that defines configuration for a module library.

Methods

impl Module

pub fn new(name: &str) -> Module

Creates a new Module structure given its name.

pub fn new_disabled(name: &str) -> Module

Creates a new, disabled Module structure given its name.

pub fn with_config(name: &str, enabled: bool, config: Value) -> Module

Creates a new Module structure given its name and configuration.

pub fn name(&self) -> &str

Obtains the name of the module.

pub fn enable(&mut self)

Enables the module.

pub fn disable(&mut self)

Disables the module.

pub fn enabled(&self) -> bool

Returns true if the module is enabled and false otherwise.

pub fn config(&self) -> Option<&Value>

Returns a reference to the TOML module configuration, if any.

pub fn config_mut(&mut self) -> Option<&mut Value>

Returns a mutable reference to the TOML module configuration, if any.

pub fn into_config(self) -> Option<Value>

Transforms the current Module structure into its TOML configuration, if any.

pub fn location(&self) -> Option<&Path>

Returns the path of the library containing this module, if any.

If no location is given, this function returns None and Mammoth uses the default module directory.

pub fn set_location<P>(&mut self, path: P) where
    P: AsRef<Path>, 

Sets the path of the library containing this module.

pub fn clear_location(&mut self)

Removes the given path of the library containing this module.

pub fn load_into(&self, mod_set: &mut LoadedModuleSet) -> Result<(), Error>

Tries to load the library.

Trait Implementations

impl Id for Module

type Identifier = String

fn id(&self) -> Self::Identifier

fn description(&self) -> &str

impl Validator<Module> for PathBuf

fn validate(&self, logger: &mut dyn Logger, item: &Module) -> Result<(), Error>

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Module

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.