Struct sccmod::module::Module

pub struct Module {

    pub name: String,
    pub version: String,
    pub class: String,
    pub dependencies: Vec<Dependency>,
    pub metadata: HashMap<String, String>,
    pub environment: HashMap<String, Environment>,
    pub root: String,
    pub pre_build: Option<Vec<String>>,
    pub downloader: Downloader,
    pub builder: Builder,
    pub source_path: String,
    pub build_path: String,
    pub install_path: String,
}

Fields

name: String

Name of the module

version: String

Module version

class: String

Module class (flavours)

dependencies: Vec<Dependency>

Module dependencies

metadata: HashMap<String, String>

Module metadata

environment: HashMap<String, Environment>

Environment variables to set/change

root: String

Path root (${root}/${name}/${version})

pre_build: Option<Vec<String>>

A list of commands to run before building

downloader: Downloader

Downloader to download the source code

builder: Builder

Builder to build and install the source code

source_path: String

build_path: String

install_path: String

Implementations

impl Module

pub fn parse( &self, flavour: &(&[Module], usize) ) -> (String, String, String, Vec<String>)

Parse a flavour into:

• flavour_str: a postfix to a path pointing to a flavour directory
• build_path: updated build path
• install_path: updated install path
• modules: module names necessary for installation

pub fn identifier(&self) -> String

pub fn download(&self) -> Result<(), String>

Download the source code for the module, based on its Downloader.

Errors

This will error if the download fails, with an error String containing either an error message or the output of the errored command.

pub fn build(&self, flavour: (&[Module], usize)) -> Result<(), String>

Build the source code for this module, based on its Builder.

Errors

This will error if the build fails, with an error String containing either an error message or the output of the errored command.

pub fn install(&self, flavour: (&[Module], usize)) -> Result<(), String>

Install the source code for this module based on its Builder.

Errors

Errors if the installation fails. The Result output contains a String with either an error message or the output of the errored program.

pub fn from_object( object: &Bound<'_, PyAny>, config: &Config ) -> Result<Self, String>

Extract a Module object from a python object.

Errors

This method will return [Err(msg)] if the object cannot be parsed successfully. msg is a string and contains the error message.

Trait Implementations

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.