Struct conciliator::spin::Spinner

pub struct Spinner<'c> { /* private fields */ }

Show that something is ongoing with an animated tag & message

This starts a separate thread (or task) that periodically overwrites the last line of the output to show the next frame of the animation. Any other output would interfere with this, so this struct tries to guard against that by holding a mutable reference to the Claw that spawned it. This ensures that that particular Claw can’t be used for the lifetime of the Spinner.

See the module-level documentation for more.

Implementations

impl<'c> Spinner<'c>

pub fn new<A, I>(claw: &'c mut Claw, animate: A, message: I) -> Self

where A: Animate + Send + 'static, I: InitialContent,

Create a new Spinner using the given animation and message

pub fn message<I: InitialContent>(&self, init: I) -> Message<'_>

Update the spinner message

The message should be short enough to fit on a single line in the terminal, and it should not contain any newlines. If the message line wraps to another line, the spinner will get messed up and leave behind lines that it shouldn’t.

pub async fn finish(self)

Available on crate feature tokio only.

Stop spinning

This changes the animation frame to show the spinner is done and un-hides the cursor. The last message set will be written out and become part of the normal output.

Note that without the tokio feature, this function is not async.

pub async fn clear(self)

Available on crate feature tokio only.

Stop spinning & remove the message line

Note that without the tokio feature, this function is not async.

Trait Implementations

impl<'c> Conciliator for Spinner<'c>

fn line<I: InitialContent>(&self, init: I) -> <Self as GetLine<'_>>::Line

Get a plain buffer without a tag

fn status<I: InitialContent>(&self, init: I) -> <Self as GetLine<'_>>::Line

Get a line buffer with the status tag

fn info<I: InitialContent>(&self, init: I) -> <Self as GetLine<'_>>::Line

Get a line buffer with the info tag

fn warn<I: InitialContent>(&self, init: I) -> <Self as GetLine<'_>>::Line

Get a line buffer with the warn tag

fn error<I: InitialContent>(&self, init: I) -> <Self as GetLine<'_>>::Line

Get a line buffer with the error tag

fn print<T: Print>(&self, thing: T)

Print a multi-line text segment

impl<'l, 'c> GetLine<'l> for Spinner<'c>

type Line = Line<'l>

Type of the line buffer (does not have to be the struct Line)

fn get_line(&'l self) -> Self::Line

Obtain a new line buffer