Struct StringOption

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

A config option with a string value.

Implementations

impl<'a> StringOption<'a>

pub fn value(&self) -> Cow<'_, str>

Get the value of the option.

Trait Implementations

impl<'a> AsRef<dyn BaseConfigOption + 'a> for StringOption<'a>

fn as_ref(&self) -> &(dyn BaseConfigOption + 'a)

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> BaseConfigOption for StringOption<'a>

fn name(&self) -> Cow<'_, str>

Get the name of the option.

fn description(&self) -> Cow<'_, str>

Get the description of the option.

fn section_name(&self) -> Cow<'_, str>

Get the section name of the section the option belongs to.

fn config_name(&self) -> Cow<'_, str>

Get the config name the option belongs to.

fn option_type(&self) -> OptionType

Get the type of the config option

fn reset(&self, run_callback: bool) -> OptionChanged

Resets the option to its default value.

fn set(&self, value: &str, run_callback: bool) -> OptionChanged

Set the option using a string.

fn is_null(&self) -> bool

Is the option undefined/null.

impl<'a> ConfigOptions for StringOption<'_>