Struct ModuleManifest 

pub struct ModuleManifest {
    pub name: String,
    pub label: String,
    pub summary: String,
    pub links: Vec<String>,
    pub provides: Provides,
    pub handles: Handles,
    pub config: Option<Configuration>,
}

Fields

name: String

label: String

summary: String

links: Vec<String>

provides: Provides

handles: Handles

config: Option<Configuration>

Implementations

impl ModuleManifest

pub fn read_manifest(module_name: &str) -> Result<Self>

pub fn read_variables( &self, profile: Option<&str>, ) -> Result<BTreeMap<String, String>, ReadVarError>

pub fn variable( &self, key: &str, profile: Option<&str>, ) -> Result<String, ReadVarError>

Examples found in repository

examples/config.rs (line 30)

fn main() -> Result<(), Box<dyn Error>> {
    let manifest: ModuleManifest = serde_yaml_ng::from_str(YAML)?;

    let api_key = manifest.variable("api_key", None).unwrap_or_default();
    if api_key.is_empty() {
        println!("api_key: `{api_key}`");
        println!(
            "(consider `mkdir -p ~/.asimov/configs/default/example/ && echo -n \"<api-key-value>\" >> ~/.asimov/configs/default/example/api_key` or for a non-example module `asimov module config <example> api_key <api-key-value>`)"
        );
    } else {
        println!("api_key: `{api_key}`");
    }

    let other_var = manifest.variable("other_var", None).unwrap_or_default();
    println!("\nother_var: `{other_var}`");

    let env_var = manifest.variable("var_from_env", None).unwrap_or_default();
    println!("\nvar_from_env: `{env_var}`");

    println!("setting env var `VAR_FROM_ENV` manually...");
    unsafe { std::env::set_var("VAR_FROM_ENV", "hello!") }
    let env_var = manifest.variable("var_from_env", None).unwrap_or_default();
    println!("var_from_env: `{env_var}`");

    // alternative way:
    // let vars = manifest.read_variables(None)?;
    // let api_key = vars.get("api_key");
    // println!("api_key: `{api_key:?}`");

    Ok(())
}

Trait Implementations

impl Clone for ModuleManifest

fn clone(&self) -> ModuleManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleManifest

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

Formats the value using the given formatter.

impl Default for ModuleManifest

fn default() -> ModuleManifest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleManifest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ModuleManifest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.