Struct SettingDoc 

pub struct SettingDoc {
    pub section: &'static str,
    pub key: &'static str,
    pub value_type: &'static str,
    pub default: &'static str,
    pub description: &'static str,
    pub scope: SettingScope,
}

Documentation for one supported config.toml key.

Fields

section: &'static str

TOML section, without brackets.

key: &'static str

TOML key inside Self::section.

value_type: &'static str

Human-readable value type.

default: &'static str

Default as displayed to users.

description: &'static str

What the setting controls.

scope: SettingScope

The wrapper(s) that consume the setting.

Trait Implementations

impl Clone for SettingDoc

fn clone(&self) -> SettingDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SettingDoc

impl Debug for SettingDoc

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

Formats the value using the given formatter.

impl Eq for SettingDoc

impl PartialEq for SettingDoc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SettingDoc