Struct ToggleSetting 

pub struct ToggleSetting {
    pub key: Cow<'static, str>,
    pub title: Cow<'static, str>,
    pub notification: Option<Cow<'static, str>>,
    pub requires: Option<Cow<'static, str>>,
    pub requires_false: Option<Cow<'static, str>>,
    pub refreshes: Option<Vec<Cow<'static, str>>>,
    pub subtitle: Option<Cow<'static, str>>,
    pub auth_to_disable: Option<bool>,
    pub default: bool,
}

A toggle switch.

This setting can be converted into a generic Setting using the Into trait.

Fields

key: Cow<'static, str>

The unique key that identifies this setting.

title: Cow<'static, str>

The display title for this setting.

notification: Option<Cow<'static, str>>

Optional notification to send to the source when this setting is changed.

requires: Option<Cow<'static, str>>

Optional key of another setting that must be enabled for this setting to be enabled.

requires_false: Option<Cow<'static, str>>

Optional key of another setting that must be disabled for this setting to be enabled.

refreshes: Option<Vec<Cow<'static, str>>>

Optional list of items that should be refreshed when this setting changes.

The valid options are:

• content
• listings
• settings

subtitle: Option<Cow<'static, str>>

Optional subtitle text.

auth_to_disable: Option<bool>

Whether to require authentication to turn the toggle off.

default: bool

The default state of the toggle.

Trait Implementations

impl Clone for ToggleSetting

fn clone(&self) -> ToggleSetting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToggleSetting

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

Formats the value using the given formatter.

impl Default for ToggleSetting

fn default() -> Self

Returns the “default value” for a type.

impl From<ToggleSetting> for Setting

fn from(source: ToggleSetting) -> Self

Converts to this type from the input type.

impl PartialEq for ToggleSetting

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ToggleSetting