Struct ConfigurationVariable 

pub struct ConfigurationVariable {
    pub name: String,
    pub description: Option<String>,
    pub environment: Option<String>,
    pub default_value: Option<String>,
    pub secret: bool,
    pub optional: bool,
}

Fields

name: String

The name of the variable. Configured variables are by default saved in ~/.asimov/configs/$profile/$module/$name.

description: Option<String>

Optional description to provide information about the variable.

environment: Option<String>

Optional name of an environment variable to check for a value before checking for a configured or a default value.

default_value: Option<String>

Optional default value to use as a fallback. If a default value is present the user configuration of the value is not required.

secret: bool

Whether the value is sensitive, such as a credential or an access token. Tools must not display secret values unless explicitly asked to.

optional: bool

Whether the module operates without a value for this variable. Only meaningful for variables that have no default value, which are otherwise taken to be required; see ConfigurationVariable::is_required.

Implementations

impl ConfigurationVariable

pub fn is_required(&self) -> bool

Whether a value must be configured for the module to operate.

Trait Implementations

impl Clone for ConfigurationVariable

fn clone(&self) -> ConfigurationVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurationVariable

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

Formats the value using the given formatter.

impl Default for ConfigurationVariable

fn default() -> ConfigurationVariable

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigurationVariable

Available on crate feature serde only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConfigurationVariable

impl PartialEq for ConfigurationVariable

fn eq(&self, other: &ConfigurationVariable) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ConfigurationVariable

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigurationVariable