Skip to main content

ProgressReporterBuilder

Struct ProgressReporterBuilder 

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

Builder for one process-wide progress-reporting session.

Implementations§

Source§

impl ProgressReporterBuilder

Source

pub fn identify_tasks_by<I, S>(self, keys: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Selects the exact parameter combination used to identify every task.

Keys may refer to fixed or swept parameters, but the complete selected tuple must be unique for every generated task. Calling this method with no keys is valid only for a one-task project.

Source

pub fn terminal(self) -> Self

Forces cursor-controlled terminal rendering even when stderr is not a terminal. Most applications should retain automatic output selection.

Source

pub fn plain(self) -> Self

Forces stable line-oriented output suitable for logs and CI systems.

Source

pub fn hidden(self) -> Self

Suppresses rendering while retaining counters and lifecycle validation.

This is useful for tests and embedding applications with their own non-terminal presentation layer. It does not disable progress tracking.

Source

pub fn start(self) -> Result<ProgressReporter, ReportingError>

Validates identities, acquires exclusive terminal ownership, and starts the centralized renderer.

Trait Implementations§

Source§

impl Debug for ProgressReporterBuilder

Source§

fn fmt(&self, formatter: &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> Same for T

Source§

type Output = T

Should always be Self
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.