Struct zng::config::settings::SettingBuilder

pub struct SettingBuilder<'a> { /* private fields */ }

Setting entry builder.

Implementations

impl<'a> SettingBuilder<'a>

pub fn key(&self) -> &Txt

The config edited by this setting.

pub fn category(&self) -> &CategoryId

Settings category.

pub fn order(&mut self, order: u16) -> &mut SettingBuilder<'a>

Set the setting order number.

Lower numbers are listed first, two categories with the same order are sorted by display name.

pub fn name(&mut self, name: impl IntoVar<Txt>) -> &mut SettingBuilder<'a>

Set the setting name.

pub fn description( &mut self, description: impl IntoVar<Txt>, ) -> &mut SettingBuilder<'a>

Set the setting short help text.

pub fn set<T>( &mut self, id: impl Into<StateId<T>>, value: impl Into<T>, ) -> &mut SettingBuilder<'a>

where T: StateValue,

Set the custom metadata value.

pub fn flag(&mut self, id: impl Into<StateId<()>>) -> &mut SettingBuilder<'a>

Set the custom metadata flag.

pub fn meta(&mut self) -> StateMapMut<'_, Setting>

Custom setting metadata.

pub fn value<T>(&mut self, default: T) -> &mut SettingBuilder<'a>

where T: ConfigValue,

Set the value variable from CONFIG.

pub fn cfg_value<T>( &mut self, cfg: &mut impl Config, default: T, ) -> &mut SettingBuilder<'a>

where T: ConfigValue,

Set the value variable from a different config.

pub fn reset( &mut self, resetter: Box<dyn FallbackConfigReset>, strip_key_prefix: impl Into<Txt>, ) -> &mut SettingBuilder<'a>

Use a FallbackConfigReset to reset the settings.

This is the preferred way of implementing reset as it keeps the user config file clean, but it does require a config setup with two files.

The strip_key_prefix is removed from config keys before passing to resetter, this is required if the config is setup using a switch over multiple files.

pub fn default<T>(&mut self, default: T) -> &mut SettingBuilder<'a>

where T: ConfigValue,

Use a default value to reset the settings.

The default value is set on the config to reset.

Trait Implementations

impl<'a> Drop for SettingBuilder<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> SettingBuilderEditorExt for SettingBuilder<'a>

fn editor_fn(&mut self, editor: WidgetFn<Setting>) -> &mut SettingBuilder<'a>

Custom editor for the setting.