MultiProgress

Struct MultiProgress 

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

Multi-progress manager for handling multiple progress indicators concurrently.

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

§Examples

use sublime_cli_tools::output::progress::MultiProgress;

let multi = MultiProgress::new();
let pb1 = multi.add_progress_bar(100);
let pb2 = multi.add_progress_bar(50);

pb1.set_message("Task 1");
pb2.set_message("Task 2");

Implementations§

Source§

impl MultiProgress

Source

pub fn new() -> Self

Creates a new multi-progress manager.

The manager is automatically suppressed if:

  • stdout is not a TTY
  • Output format is JSON or quiet
§Examples
use sublime_cli_tools::output::progress::MultiProgress;

let multi = MultiProgress::new();
Source

pub fn new_with_format(format: OutputFormat) -> Self

Creates a new multi-progress manager with explicit format control.

§Examples
use sublime_cli_tools::output::{progress::MultiProgress, OutputFormat};

let multi = MultiProgress::new_with_format(OutputFormat::Human);
Source

pub fn add_progress_bar(&self, len: u64) -> ProgressBar

Adds a progress bar to the multi-progress manager.

§Examples
use sublime_cli_tools::output::progress::MultiProgress;

let multi = MultiProgress::new();
let pb = multi.add_progress_bar(100);
pb.set_message("Processing...");
Source

pub fn add_spinner(&self, msg: impl Into<String>) -> Spinner

Adds a spinner to the multi-progress manager.

§Examples
use sublime_cli_tools::output::progress::MultiProgress;

let multi = MultiProgress::new();
let spinner = multi.add_spinner("Loading...");
Source

pub fn clear(&self)

Clears all progress indicators.

§Examples
use sublime_cli_tools::output::progress::MultiProgress;

let multi = MultiProgress::new();
let pb = multi.add_progress_bar(100);
multi.clear();
Source

pub fn is_active(&self) -> bool

Returns true if the multi-progress manager is active (not suppressed).

§Examples
use sublime_cli_tools::output::progress::MultiProgress;

let multi = MultiProgress::new();
if multi.is_active() {
    println!("Multi-progress is active");
}

Trait Implementations§

Source§

impl Default for MultiProgress

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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<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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more