Struct termprogress::spinner::Spin

pub struct Spin { /* fields omitted */ }

A single character spinner with optional title that can be told to spin whenever it wants. It implements Spinner trait, and is the default spinner.

The spinner takes up a line, and renders it's spinner on the end of its title. Calling the Spinner::bump() function will cause the character sequence to advance.

Usage

To use the spinner you can provide it a Wheel (see [wheel] module), or it implements the Default trait, creating a traditional looking spinner (|/-\)

let mut spin = Spin::default(); //Default new spinner without a title.

How it looks

It renders in the terminal like: This is a spinner /

Implementations

impl Spin

pub fn with_title(title: &str, whl: Wheel) -> Self

Create a new spinner with title and wheel.

To give it the default wheel, you can pass whl Default::default() to use the default one.

pub fn new(whl: Wheel) -> Self

Create a new blank spinner with a wheel

Example

 Spin::new(Default::default()); // Create a spinner with the default wheel ('|/-\')

pub fn complete(self)

Consume the spinner and complete it. Removes the spin character.

pub fn complete_with(self, msg: &str)

Consume the spinner and complete it with a message. Removes the spin character and then prints the message.

Trait Implementations

impl Default for Spin

fn default() -> Self

Returns the "default value" for a type.

impl Display for Spin

fn refresh(&self)

Refresh the display

fn blank(&self)

Blank the display

fn get_title(&self) -> &str

Get the title for this display

fn set_title(&mut self, from: &str)

Set the title for this display

fn update_dimensions(&mut self, _to: usize)

Update the max size if needed

fn println(&self, string: &str)

Blank then print a line, and redisplay.

fn eprintln(&self, string: &str)

Blank then print a line std stderr, and redisplay.

impl Spinner for Spin

fn bump(&mut self)