Struct termprogress::spinner::Spin

pub struct Spin<T: ?Sized = Stdout> { /* private fields */ }

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 /

Thread Syncsafety

This type is safely Sync (where T is), the behaviour is defined to prevent overlapping writes to T. Though it is advised to not render a Spin from more than a single thread, you still safely can.

A display operation on one thread will cause any other threads attempting on to silently and safely abort their display attempt before anything is written to output.

Implementations

impl Spin

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

Create a new spinner with title and wheel writing to stdout.

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

pub fn new_default(whl: Wheel) -> Self

Create a new blank spinner with a wheel writing to stdout.

Example

 Spin::new_default(Default::default()); // Create a spinner with the default wheel ('|/-\') that writes to stdout.

impl<T> Spin<T>

pub fn into_inner(self) -> T

Return the backing write object

impl<T: ?Sized> Spin<T>

pub fn inner_mut(&mut self) -> &mut T

Get a mutable reference to the inner object

pub fn inner(&self) -> Option<AtomicRef<'_, T>>

Get a shared reference to the inner object

Returns

None is returned if a display operation is currently in progress on another thread.

Operation suspension

As long as the returned reference lives, all display operations will fail silently, on this thread and any other. This method should be avoided in favour of &*inner_mut() when exclusive ownership is avaliable.

impl<T: Write> Spin<T>

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

Create a new spinner with title and wheel writing to output.

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

pub fn new(output: T, whl: Wheel) -> Self

Create a new blank spinner with a wheel writing to output.

Example

 Spin::new(std::io::stdout(), Default::default()); // Create a spinner with the default wheel ('|/-\') that writes to stdout.

pub fn complete(self) -> Result<()>

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

pub fn complete_with(self, msg: &str) -> Result<()>

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<T: ?Sized + Write> Display for Spin<T>

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, _: 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<T: ?Sized + Write> Spinner for Spin<T>

fn bump(&mut self)

Cause the spinner to increment once.

impl<T: Write> WithTitle for Spin<T>

fn with_title(self, t: impl AsRef<str>) -> Self

Add a title to this indicator.

fn add_title(&mut self, t: impl AsRef<str>)

Add a title to this indicator.

fn update(&mut self)

fn complete(self)