Skip to main content

Status

Struct Status 

Source
pub struct Status {
    pub spinner: Spinner,
    pub status: String,
    pub started: Option<Instant>,
}
Expand description

A status message rendered with an animated spinner.

Usage:

let status = Status::new("Working...");
status.start();
// do work...
status.update("Still working...");
status.stop();

Fields§

§spinner: Spinner§status: String§started: Option<Instant>

Implementations§

Source§

impl Status

Source

pub fn new(status: impl Into<String>) -> Self

Create a new Status with the given message.

Source

pub fn spinner(self, spinner: Spinner) -> Self

Builder: replace the default spinner with a custom Spinner.

Source

pub fn start(&mut self) -> Result<()>

Start displaying the status.

Source

pub fn update(&mut self, status: impl Into<String>) -> Result<()>

Update the status message.

Source

pub fn stop(&mut self) -> Result<()>

Stop the status display (clears the line).

Source

pub fn refresh(&mut self) -> Result<()>

Refresh the display.

Trait Implementations§

Source§

impl Debug for Status

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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.