Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature toggle-group only.

The items and which of them are on.

Implementations

impl<Id: Copy + PartialEq> State<Id>

pub fn single(items: impl IntoIterator<Item = Item<Id>>) -> Self

A group where at most one item is on, starting with none.

pub fn multiple(items: impl IntoIterator<Item = Item<Id>>) -> Self

A group where every item switches on and off by itself.

pub fn with_selected(self, ids: impl IntoIterator<Item = Id>) -> Self

Switches these items on, skipping unknown and disabled ones. In single mode the first that applies replaces the selection.

pub fn required(self, required: bool) -> Self

Keeps the last item in a single-mode group on, so pressing it again does nothing rather than leaving the group empty. When nothing is on yet, the first enabled item is switched on.

pub fn mode(&self) -> Mode

pub fn is_required(&self) -> bool

pub fn items(&self) -> &[Item<Id>]

pub fn selected(&self) -> Vec<Id>

The ids that are on, in item order.

pub fn selected_one(&self) -> Option<Id>

The first id that is on, which in single mode is the only one.

pub fn is_selected(&self, id: Id) -> bool

pub fn set_disabled(&mut self, id: Id, disabled: bool)

Enables or disables an item. Whether it is on stays as it was.

pub fn update(&mut self, event: Event<Id>) -> Option<Vec<Id>>

Applies an event and returns the ids that are on afterwards, if anything changed.

Trait Implementations

impl<Id: Clone> Clone for State<Id>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for State<Id>

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

Formats the value using the given formatter.

impl<Id: PartialEq> PartialEq for State<Id>

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

Equality operator ==.

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

Inequality operator !=.

impl<Id: PartialEq> StructuralPartialEq for State<Id>