Struct throbber_widgets_tui::widgets::ThrobberState

pub struct ThrobberState { /* private fields */ }

State to be used for Throbber render.

Implementations

impl ThrobberState

pub fn index(&self) -> i8

Get a index.

pub fn calc_next(&mut self)

Increase index.

Examples:

let mut throbber_state = throbber_widgets_tui::ThrobberState::default();
assert_eq!(throbber_state.index(), 0);
throbber_state.calc_next();
assert_eq!(throbber_state.index(), 1);

Examples found in repository

examples/demo.rs (line 8)

    fn on_tick(&mut self) {
        self.states.iter_mut().for_each(|state| state.calc_next());
    }

pub fn calc_step(&mut self, step: i8)

Calculate the index by specifying step.

Negative numbers can also be specified for step.

If step is 0, the index is determined at random.

Examples:

let mut throbber_state = throbber_widgets_tui::ThrobberState::default();
assert_eq!(throbber_state.index(), 0);
throbber_state.calc_step(2);
assert_eq!(throbber_state.index(), 2);
throbber_state.calc_step(-3);
assert_eq!(throbber_state.index(), -1);
throbber_state.calc_step(0); // random
assert!((std::i8::MIN..=std::i8::MAX).contains(&throbber_state.index()))

pub fn normalize(&mut self, throbber: &Throbber<'_>)

Set the index to the range of throbber_set.symbols.len().

This is called from render function automatically.

Examples:

let mut throbber_state = throbber_widgets_tui::ThrobberState::default();
let throbber = throbber_widgets_tui::Throbber::default();
let len = 6; //throbber.throbber_set.symbols.len() as i8;

throbber_state.normalize(&throbber);
assert_eq!(throbber_state.index(), 0);

throbber_state.calc_step(len + 2);
assert_eq!(throbber_state.index(), len + 2);
throbber_state.normalize(&throbber);
assert_eq!(throbber_state.index(), 2);

// Negative numbers are indexed from backward
throbber_state.calc_step(-3 - len);
assert_eq!(throbber_state.index(), -1 - len);
throbber_state.normalize(&throbber);
assert_eq!(throbber_state.index(), len - 1);

Trait Implementations

impl Clone for ThrobberState

fn clone(&self) -> ThrobberState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThrobberState

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

Formats the value using the given formatter.

impl Default for ThrobberState

fn default() -> ThrobberState

Returns the “default value” for a type.