Skip to main content

JsonWriterProgressReporter

Struct JsonWriterProgressReporter 

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

Progress reporter that writes JSON metric snapshots to a writer.

One input event can produce multiple JSON lines: one line for each metric counter carried by the event.

Implementations§

Source§

impl<W> JsonWriterProgressReporter<W>

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.

Source§

impl<W> JsonWriterProgressReporter<W>
where W: Write + Send + 'static,

Source

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

Creates a reporter from a shared writer.

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

A JSON writer-backed progress reporter.

Source

pub fn from_writer(writer: W) -> Self

Creates a reporter from an owned writer.

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

A JSON writer-backed progress reporter.

Trait Implementations§

Source§

impl<W> ProgressReporter for JsonWriterProgressReporter<W>
where W: Write + Send + 'static,

Source§

fn report(&self, event: &ProgressEvent)

Writes one JSON line for every metric snapshot in the event.

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

Recovers the inner writer when the writer mutex is poisoned, and panics only when 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.