Struct timely_logging::Logger

pub struct Logger<T> { /* private fields */ }

A buffering logger.

Implementations

impl<T> Logger<T>

pub fn new<F>(time: Instant, offset: Duration, action: F) -> Self

where F: FnMut(&Duration, &mut Vec<(Duration, T)>) + 'static,

Allocates a new shareable logger bound to a write destination.

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

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, I::Item: Into<T>,

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(&mut self)

Flushes logged messages and communicates the new minimal timestamp.

Trait Implementations

impl<T> Clone for Logger<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Logger<T>

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

Formats the value using the given formatter.