Struct TypedLogger

pub struct TypedLogger<CB: ContainerBuilder, T> { /* private fields */ }

A logger that’s typed to specific events. Its log functions accept events that can be converted into T. Dereferencing a TypedLogger gives you a Logger that can log any compatible type.

Construct a TypedLogger with Logger::into_typed or by calling into on a Logger.

Implementations

impl<CB: ContainerBuilder, T> TypedLogger<CB, T>

pub fn log<S: Into<T>>(&self, event: S)

where CB: PushInto<(Duration, T)>,

Logs an event. Equivalent to Logger::log, with the exception that it converts the event to T before logging.

pub fn log_many<I>(&self, events: I)

where I: IntoIterator, I::Item: Into<T>, CB: PushInto<(Duration, T)>,

Logs multiple events. Equivalent to Logger::log_many, with the exception that it converts the events to T before logging.

Methods from Deref<Target = Logger<CB>>

pub fn log<T>(&self, event: T)

where CB: PushInto<(Duration, T)>,

Logs an event.

The event has its timestamp recorded at the moment of logging, but it may be delayed due to buffering. It will be written when the logger is next flushed, either due to the buffer reaching capacity or a direct call to flush.

This implementation borrows a shared (but thread-local) buffer of log events, to ensure that the action only sees one stream of events with increasing timestamps. This may have a cost that we don’t entirely understand.

pub fn log_many<I>(&self, events: I)

where I: IntoIterator, CB: PushInto<(Duration, I::Item)>,

Logs multiple events.

The event has its timestamp recorded at the moment of logging, but it may be delayed due to buffering. It will be written when the logger is next flushed, either due to the buffer reaching capacity or a direct call to flush.

All events in this call will have the same timestamp. This can be more performant due to fewer time.elapsed() calls, but it also allows some logged events to appear to be “transactional”, occurring at the same moment.

This implementation borrows a shared (but thread-local) buffer of log events, to ensure that the action only sees one stream of events with increasing timestamps. This may have a cost that we don’t entirely understand.

pub fn flush(&self)

Flushes logged messages and communicates the new minimal timestamp.

Trait Implementations

impl<CB: ContainerBuilder, T> Clone for TypedLogger<CB, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CB: Debug + ContainerBuilder, T: Debug> Debug for TypedLogger<CB, T>

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

Formats the value using the given formatter.

impl<CB: ContainerBuilder, T> Deref for TypedLogger<CB, T>

type Target = Logger<CB>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<CB: ContainerBuilder, T> From<Logger<CB>> for TypedLogger<CB, T>

fn from(inner: Logger<CB>) -> Self

Converts to this type from the input type.