Skip to main content

WriterProgressReporter

Struct WriterProgressReporter 

Source
pub struct WriterProgressReporter<W> { /* private fields */ }
Expand description

Progress reporter that writes human-readable events to a writer.

§Type Parameters

  • W - Writer receiving formatted progress events.

Implementations§

Source§

impl<W> WriterProgressReporter<W>

Source

pub fn new(writer: Arc<Mutex<W>>) -> Self

Creates a reporter from a shared writer.

§Parameters
  • writer - Shared writer receiving progress output.
§Returns

A writer-backed progress reporter.

Source

pub fn from_writer(writer: W) -> Self

Creates a reporter from an owned writer.

§Parameters
  • writer - Owned writer receiving progress output.
§Returns

A writer-backed progress reporter.

Source

pub const fn writer(&self) -> &Arc<Mutex<W>>

Returns the shared writer used by this reporter.

§Returns

A shared reference to the writer mutex.

Trait Implementations§

Source§

impl<W: Debug> Debug for WriterProgressReporter<W>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<W> ProgressReporter for WriterProgressReporter<W>
where W: Write + Send,

Source§

fn report(&self, event: &ProgressEvent)

Writes one progress event as a single human-readable line.

§Parameters
  • event - Progress event to format and write.
§Panics

Panics when the writer mutex is poisoned or writing to the configured writer fails.

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.