Struct ConfigSetting 

pub struct ConfigSetting {
    pub key: String,
    pub description: String,
    pub default: Option<String>,
    pub value_type: ConfigValueType,
}

A single setting a plugin or module declares as configurable.

Fields

key: String

Dotted key in the workspace config, e.g. skill.dest. The segment before the first . is the owning namespace (usually the plugin name).

description: String

One-line description shown by meta config list.

default: Option<String>

Default value (as a display string) used when the key is unset.

value_type: ConfigValueType

Declared value type, used for validation and display.

Implementations

impl ConfigSetting

pub fn new( key: impl Into<String>, description: impl Into<String>, value_type: ConfigValueType, ) -> ConfigSetting

Declare a setting with a dotted key, description, and value type.

pub fn with_default(self, default: impl Into<String>) -> ConfigSetting

Attach a default value shown when the setting is unset.

pub fn namespace(&self) -> &str

The namespace (segment before the first .), usually the plugin name.

Trait Implementations

impl Clone for ConfigSetting

fn clone(&self) -> ConfigSetting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigSetting

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigSetting

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConfigSetting

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

where __S: Serializer,

Serialize this value into the given Serde serializer.