Skip to main content

SpinnerLineHandle

Struct SpinnerLineHandle 

Source
pub struct SpinnerLineHandle { /* private fields */ }
Expand description

Handle for controlling a single spinner line within a multi-spinner group.

SpinnerLineHandle is Send so it can be moved to worker threads.

Implementations§

Source§

impl SpinnerLineHandle

Source

pub fn update(&self, message: impl Into<String>)

Update the message for this spinner line.

§Panics

Panics if the internal mutex is poisoned.

Source

pub fn success(self)

Finalize this spinner line with a green ✔ and the current message.

§Panics

Panics if the internal mutex is poisoned.

Source

pub fn success_with(self, message: impl Into<String>)

Finalize this spinner line with a green ✔ and a replacement message.

§Panics

Panics if the internal mutex is poisoned.

Source

pub fn fail(self)

Finalize this spinner line with a red ✖ and the current message.

§Panics

Panics if the internal mutex is poisoned.

Source

pub fn fail_with(self, message: impl Into<String>)

Finalize this spinner line with a red ✖ and a replacement message.

§Panics

Panics if the internal mutex is poisoned.

Source

pub fn clear(self)

Silently dismiss this spinner line.

The line disappears from the terminal on the next render frame (TTY mode) or produces no output at all (plain mode). Remaining lines collapse together with no gap.

This consumes the handle, preventing further updates.

§Panics

Panics if the internal mutex is poisoned.

Auto Trait Implementations§

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, U> Into<U> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.