Struct State 

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

Available on crate feature status-bar only.

The items and the spinners’ phase.

Implementations

impl<Id: PartialEq> State<Id>

pub fn new() -> Self

An empty bar.

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

A bar starting with items, as if each had been set in turn.

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

Every item, in the order it was first set.

pub fn item(&self, id: &Id) -> Option<&Item<Id>>

pub fn section(&self, section: Section) -> impl Iterator<Item = &Item<Id>>

The items in one section, in order.

pub fn is_empty(&self) -> bool

pub fn phase(&self) -> f32

The spinners’ phase, in turns.

pub fn needs_frames(&self) -> bool

Whether any spinner is showing, so frames are needed.

pub fn apply(&mut self, update: Update<Id>)

Applies one update, as the channel does.

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

Applies an event and returns what the app may need to act on.

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> Default for State<Id>

fn default() -> Self

Returns the “default value” for a type.

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>