Skip to main content

AutoReporter

Struct AutoReporter 

Source
pub struct AutoReporter<'scope, 'reporter> { /* private fields */ }
Expand description

Handle controlling one scoped automatic reporter.

Implementations§

Source§

impl<'scope, 'reporter> AutoReporter<'scope, 'reporter>

Source

pub fn notifier(&self) -> ProgressNotifier

Returns a cloneable worker notification handle.

Source

pub fn status(&self) -> AutoReporterStatus

Returns a cloneable status view for workers.

Source

pub fn stop(self) -> Result<(), AutoReporterError>

Stops, joins and returns the background report result.

A reporter or snapshot error is returned as AutoReporterError::Emission. A worker panic is captured as AutoReporterError::Panicked after the worker has been joined.

§Errors

Returns a reporter emission failure or a structured worker panic.

Trait Implementations§

Source§

impl Drop for AutoReporter<'_, '_>

Source§

fn drop(&mut self)

Stops and joins a forgotten reporter without silently leaving a thread.

Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'scope, 'reporter> !RefUnwindSafe for AutoReporter<'scope, 'reporter>

§

impl<'scope, 'reporter> !UnwindSafe for AutoReporter<'scope, 'reporter>

§

impl<'scope, 'reporter> Freeze for AutoReporter<'scope, 'reporter>

§

impl<'scope, 'reporter> Send for AutoReporter<'scope, 'reporter>

§

impl<'scope, 'reporter> Sync for AutoReporter<'scope, 'reporter>

§

impl<'scope, 'reporter> Unpin for AutoReporter<'scope, 'reporter>

§

impl<'scope, 'reporter> UnsafeUnpin for AutoReporter<'scope, 'reporter>

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.