Struct Spinner 

pub struct Spinner {
    pub states: SpinnerStates,
    pub view_auto_step: bool,
    /* private fields */
}

A textual spinner which step changes at each view() call (if manual_step is disabled).

Fields

states: SpinnerStates

view_auto_step: bool

Automatically call SpinnerStates::step in view.

This option might be removed in a future major version

Implementations

impl Spinner

pub fn foreground(self, fg: Color) -> Self

Set the main foreground color. This may get overwritten by individual text styles.

pub fn background(self, bg: Color) -> Self

Set the main background color. This may get overwritten by individual text styles.

pub fn style(self, style: Style) -> Self

Set the main style. This may get overwritten by individual text styles.

This option will overwrite any previous foreground, background!

pub fn sequence<S: Into<String>>(self, s: S) -> Self

Set the sequence of characters to step through.

pub fn manual_step(self) -> Self

Disable automatically stepping the sequence in a view call.

Trait Implementations

impl Component for Spinner

fn view(&mut self, render: &mut Frame<'_>, area: Rect)

Based on the current properties and states, renders the component in the provided area frame. Render can also mutate the component state if this is required

fn query<'a>(&'a self, attr: Attribute) -> Option<QueryResult<'a>>

Query attribute of component properties.

fn attr(&mut self, attr: Attribute, value: AttrValue)

Set attribute to properties. query describes the name, while attr the value it’ll take

fn state(&self) -> State

Get current state from component

fn perform(&mut self, cmd: Cmd) -> CmdResult

Perform a command on the component. The command will may change the component state. The method returns the result of the command applied (what changed if any)

impl Default for Spinner

fn default() -> Self

Returns the “default value” for a type.