Struct Spinner 

pub struct Spinner { /* private fields */ }

Spinner for indeterminate operations with unknown duration.

Automatically suppressed in non-TTY, JSON mode, or quiet mode. When suppressed, all operations become no-ops.

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
// ... do work ...
spinner.finish_with_message("✓ Done");

Implementations

impl Spinner

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

Creates a new spinner with the given message.

The spinner is automatically suppressed if:

• stdout is not a TTY
• Output format is JSON or quiet

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading packages...");

pub fn new_with_format(msg: impl Into<String>, format: OutputFormat) -> Self

Creates a new spinner with explicit format control.

Examples

use sublime_cli_tools::output::{progress::Spinner, OutputFormat};

let spinner = Spinner::new_with_format("Loading...", OutputFormat::Human);

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

Sets the spinner message.

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
spinner.set_message("Still loading...");

pub fn tick(&self)

Manually ticks the spinner (usually not needed due to steady tick).

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
spinner.tick();

pub fn finish(&self)

Finishes the spinner and clears it.

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
spinner.finish();

pub fn finish_with_message(&self, msg: impl Into<String>)

Finishes the spinner with a message.

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
spinner.finish_with_message("✓ Loaded 5 packages");

pub fn abandon(&self)

Finishes the spinner and abandons it (shows as incomplete).

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
spinner.abandon();

pub fn abandon_with_message(&self, msg: impl Into<String>)

Finishes the spinner and abandons it with a message.

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
spinner.abandon_with_message("✗ Failed to load");

pub fn is_active(&self) -> bool

Returns true if the spinner is active (not suppressed).

Examples

use sublime_cli_tools::output::progress::Spinner;

let spinner = Spinner::new("Loading...");
if spinner.is_active() {
    println!("Spinner is active");
}