Struct ConfigOption

pub struct ConfigOption {
    pub name: String,
    pub description: String,
    pub default_value: Value,
    pub constraint: Option<Validator>,
    pub stability: Stability,
    pub active: bool,
    pub display_hint: DisplayHint,
}

A configuration option.

Fields

name: String

The name of the configuration option.

The associated environment variable has the format of <PREFIX>_CONFIG_<NAME>.

description: String

The description of the configuration option.

The description will be included in the generated markdown documentation.

default_value: Value

The default value of the configuration option.

constraint: Option<Validator>

An optional validator for the configuration option.

stability: Stability

The stability of the configuration option.

active: bool

Whether the config option should be offered to the user.

Inactive options are not included in the documentation, and accessing them provides the default value.

display_hint: DisplayHint

A display hint (for tooling)

Implementations

impl ConfigOption

pub fn full_env_var(&self, crate_name: &str) -> String

Get the corresponding ENV_VAR name given the crate-name

Trait Implementations

impl Clone for ConfigOption

fn clone(&self) -> ConfigOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigOption

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConfigOption

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConfigOption

impl StructuralPartialEq for ConfigOption