Struct Spinner 

pub struct Spinner { /* private fields */ }

Available on crate feature spinner only.

A single-line terminal spinner with a live message.

Implementations

impl Spinner

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

Start the spinner with an initial message.

When stderr is not a TTY no thread is spawned and ticks are suppressed; terminal completion lines (success/failure) are still printed so logs remain informative.

The first TTY-bound call also installs a process-wide SIGINT / SIGTERM / SIGHUP handler and a panic hook that restore the cursor before letting the process die: Drop is skipped on signal-induced termination and on panic = abort, so without these hooks cursor::Hide from the render loop would leak past process exit.

Examples found in repository

examples/spinner.rs (line 12)

fn main() {
    let spinner = Spinner::start("Resolving MX records for example.com…");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing imap.example.com:993");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing smtp.example.com:465");
    sleep(Duration::from_secs(1));

    spinner.success("Found IMAP at imap.example.com:993 and SMTP at smtp.example.com:465");

    let spinner = Spinner::start("Probing pop.example.com:995");
    sleep(Duration::from_secs(1));
    spinner.failure("No POP server reachable at pop.example.com:995");
}

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

Replace the message displayed next to the spinner frame.

Examples found in repository

examples/spinner.rs (line 15)

fn main() {
    let spinner = Spinner::start("Resolving MX records for example.com…");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing imap.example.com:993");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing smtp.example.com:465");
    sleep(Duration::from_secs(1));

    spinner.success("Found IMAP at imap.example.com:993 and SMTP at smtp.example.com:465");

    let spinner = Spinner::start("Probing pop.example.com:995");
    sleep(Duration::from_secs(1));
    spinner.failure("No POP server reachable at pop.example.com:995");
}

pub fn success(self, message: impl AsRef<str>)

Stop the spinner and print a green ✓ followed by message.

Examples found in repository

examples/spinner.rs (line 21)

fn main() {
    let spinner = Spinner::start("Resolving MX records for example.com…");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing imap.example.com:993");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing smtp.example.com:465");
    sleep(Duration::from_secs(1));

    spinner.success("Found IMAP at imap.example.com:993 and SMTP at smtp.example.com:465");

    let spinner = Spinner::start("Probing pop.example.com:995");
    sleep(Duration::from_secs(1));
    spinner.failure("No POP server reachable at pop.example.com:995");
}

pub fn failure(self, message: impl AsRef<str>)

Stop the spinner and print a red ✗ followed by message.

Examples found in repository

examples/spinner.rs (line 25)

fn main() {
    let spinner = Spinner::start("Resolving MX records for example.com…");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing imap.example.com:993");
    sleep(Duration::from_secs(1));

    spinner.set_message("Probing smtp.example.com:465");
    sleep(Duration::from_secs(1));

    spinner.success("Found IMAP at imap.example.com:993 and SMTP at smtp.example.com:465");

    let spinner = Spinner::start("Probing pop.example.com:995");
    sleep(Duration::from_secs(1));
    spinner.failure("No POP server reachable at pop.example.com:995");
}

pub fn clear(self)

Stop the spinner and clear its line without printing anything in its place.

Trait Implementations

impl Drop for Spinner

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.