Struct Spinner

Source

pub struct Spinner { /* private fields */ }

Expand description

A terminal spinner that runs in a background tokio task.

Create with Spinner::start(msg). The spinner writes frames to stderr using carriage-return overwriting. Call stop() to cancel and erase.

If stderr is not a TTY (piped, redirected), the spinner is a no-op — start() returns a Spinner whose stop() does nothing.

Implementations§

Source §

impl Spinner

Source

pub fn start(msg: impl Into<String>) -> Self

Start a spinner with the given message.

The message is displayed after the spinner frame: ⠋ thinking…

Returns immediately. The spinner runs in a background tokio task.

Source

pub fn stop(self)

Stop the spinner and erase its line from stderr.

This is idempotent — calling stop() multiple times is safe.

Trait Implementations§

Source §

impl Drop for Spinner

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Spinner

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §