Struct SpinnerState 

pub struct SpinnerState { /* private fields */ }

State for an animated spinner widget.

Create with a named constructor such as SpinnerState::dots or SpinnerState::line (or from a SpinnerPreset via SpinnerState::preset), then pass to Context::spinner each frame. The frame advances automatically with the tick counter.

Implementations

impl SpinnerState

pub fn dots() -> Self

Create a dots-style spinner using braille characters.

Cycles through: ⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏

pub fn line() -> Self

Create a line-style spinner using ASCII characters.

Cycles through: | / - \

pub fn moon() -> Self

Create a moon-phase spinner.

Cycles through: 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘

Available since 0.21.1.

pub fn bounce() -> Self

Create a bouncing single-dot spinner.

Cycles through ⠁ ⠂ ⠄ ⠂, giving a dot that rises and falls in place.

Available since 0.21.1.

pub fn circle() -> Self

Create a quarter-circle arc spinner.

Cycles through: ◜ ◠ ◝ ◞ ◡ ◟

Available since 0.21.1.

pub fn points() -> Self

Create a travelling braille-dot (“points”) spinner.

Cycles through: ⠁ ⠂ ⠄ ⡀ ⢀ ⠠ ⠐ ⠈

Available since 0.21.1.

pub fn arc() -> Self

Create a half-circle arc spinner.

Cycles through: ◜ ◠ ◝ ◞ ◡ ◟

Available since 0.21.1.

pub fn toggle() -> Self

Create a two-frame toggle/pulse spinner.

Cycles through: ⊶ ⊷

Available since 0.21.1.

pub fn arrow() -> Self

Create a rotating-arrow spinner.

Cycles clockwise through: ← ↖ ↑ ↗ → ↘ ↓ ↙

Available since 0.21.1.

pub fn preset(preset: SpinnerPreset) -> Self

Create a spinner from a named SpinnerPreset.

Equivalent to calling the matching named constructor.

Example

let s = SpinnerState::preset(SpinnerPreset::Moon);
assert_eq!(s, SpinnerState::moon());

Available since 0.21.1.

pub fn frame_count(&self) -> usize

Number of distinct frames in this spinner’s cycle.

Useful for tests and for detecting wrap-around.

Example

assert_eq!(SpinnerState::line().frame_count(), 4);

Available since 0.21.1.

pub fn frame(&self, tick: u64) -> char

Return the spinner character for the given tick.

Trait Implementations

impl Clone for SpinnerState

fn clone(&self) -> SpinnerState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpinnerState

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

Formats the value using the given formatter.

impl Default for SpinnerState

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SpinnerState

fn eq(&self, other: &SpinnerState) -> 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 Eq for SpinnerState

impl StructuralPartialEq for SpinnerState