Struct SettingSpec 

#[non_exhaustive]
pub struct SettingSpec {
    pub key: String,
    pub label: String,
    pub tooltip: Option<String>,
    pub kind: SettingKind,
}

A setting a mod registers with Registrar::register_setting: its key (unique within the mod), the translation keys of its label and tooltip, and what it is.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: String

The setting’s key within its mod (zoom_speed): a-z, 0-9, _, - and ., at most SETTING_KEY_MAX bytes, not starting with ..

label: String

The translation key of the label its row shows.

tooltip: Option<String>

The translation key of the tooltip its row shows, if any.

kind: SettingKind

What it is, with its default.

Implementations

impl SettingSpec

pub fn toggle( key: impl Into<String>, label: impl Into<String>, default: bool, ) -> SettingSpec

An on/off setting.

pub fn choice<S>( key: impl Into<String>, label: impl Into<String>, options: impl IntoIterator<Item = S>, default: usize, ) -> SettingSpec

where S: Into<String>,

One of options (translation keys), default being an index into them.

pub fn range( key: impl Into<String>, label: impl Into<String>, min: f64, max: f64, step: f64, default: f64, ) -> SettingSpec

A number from min to max in steps of step.

pub fn color( key: impl Into<String>, label: impl Into<String>, default: u32, ) -> SettingSpec

A colour, 0xRRGGBB.

pub fn tooltip(self, tooltip: impl Into<String>) -> SettingSpec

Sets the tooltip’s translation key.

pub fn check(&self) -> Result<(), SettingError>

Whether the registrar takes it: the key’s form, a label, and a kind whose default fits.

pub fn default_value(&self) -> SettingValue

The default value.

pub fn read(&self, stored: Option<&str>) -> SettingValue

The value kept as stored (see SettingSpec::store), or the default when nothing is kept, or when what is kept isn’t a value of this setting (another kind, out of range).

pub fn store(&self, value: SettingValue) -> Option<String>

How value is kept: the text SettingSpec::read gives back. None when value isn’t one of this setting’s (another kind, out of range).

Trait Implementations

impl Clone for SettingSpec

fn clone(&self) -> SettingSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingSpec

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

Formats the value using the given formatter.

impl PartialEq for SettingSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SettingSpec

impl Wire for SettingSpec

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<SettingSpec, WireError>

Decodes one value, leaving any following bytes for the caller.