Struct LoggingOutputHandler

pub struct LoggingOutputHandler { /* private fields */ }

A custom output handler for fancy logging.

Implementations

impl LoggingOutputHandler

pub fn from_multi_progress( multi_progress: MultiProgress, ) -> LoggingOutputHandler

Create a new logging handler with the given multi-progress.

pub fn with_indent_levels(&self, template: &str) -> String

Return a string with the current indentation level (bars added to the front of the string).

pub fn multi_progress(&self) -> &MultiProgress

Return the multi-progress instance.

pub fn default_bytes_style(&self) -> ProgressStyle

Returns the style to use for a progressbar that is currently in progress.

pub fn default_progress_style(&self) -> ProgressStyle

Returns the style to use for a progressbar that is currently in progress.

pub fn deserializing_progress_style(&self) -> ProgressStyle

Returns the style to use for a progressbar that is in Deserializing state.

pub fn finished_progress_style(&self) -> ProgressStyle

Returns the style to use for a progressbar that is finished.

pub fn errored_progress_style(&self) -> ProgressStyle

Returns the style to use for a progressbar that is in error state.

pub fn long_running_progress_style(&self) -> ProgressStyle

Returns the style to use for a progressbar that is indeterminate and simply shows a spinner.

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

Adds a progress bar to the handler.

pub fn set_progress_bars_hidden(&self, hidden: bool)

Set progress bars to hidden

pub fn wrap_in_progress<T, F: FnOnce() -> T>( &self, msg: impl Into<Cow<'static, str>>, func: F, ) -> T

Displays a spinner with the given message while running the specified function to completion.

pub async fn wrap_in_progress_async<T, Fut: Future<Output = T>>( &self, msg: impl Into<Cow<'static, str>>, future: Fut, ) -> T

Displays a spinner with the given message while running the specified function to completion.

pub async fn wrap_in_progress_async_with_progress<T, Fut: Future<Output = T>, F: FnOnce(ProgressBar) -> Fut>( &self, msg: impl Into<Cow<'static, str>>, f: F, ) -> T

Displays a spinner with the given message while running the specified function to completion.

Trait Implementations

impl Clone for LoggingOutputHandler

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LoggingOutputHandler

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

Formats the value using the given formatter.

impl Default for LoggingOutputHandler

fn default() -> Self

Creates a new output handler.

impl<S> Layer<S> for LoggingOutputHandler

where S: Subscriber + for<'a> LookupSpan<'a>,

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given Attributes and Id.

fn on_enter(&self, id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.

fn on_exit(&self, id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.

fn on_event(&self, event: &Event<'_>, _ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber.

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a Subscriber.

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite.

fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current Context, similarly to Subscriber::enabled.

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.

fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>

where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered struct implementing Layer.

fn with_subscriber(self, inner: S) -> Layered<Self, S>

where Self: Sized,

Composes this Layer with the given Subscriber, returning a Layered struct that implements Subscriber.

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>

where Self: Sized, F: Filter<S>,

Combines self with a Filter, returning a Filtered layer.

fn boxed(self) -> Box<dyn Layer<S> + Send + Sync>

where Self: Sized + Layer<S> + Send + Sync + 'static, S: Subscriber,

Erases the type of this Layer, returning a Boxed dyn Layer trait object.

impl<'a> MakeWriter<'a> for LoggingOutputHandler

type Writer = LoggingOutputHandler

The concrete io::Write implementation returned by make_writer.

fn make_writer(&'a self) -> Self::Writer

Returns an instance of Writer.

fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer

Returns a Writer for writing data from the span or event described by the provided Metadata.

impl Write for LoggingOutputHandler

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.