Struct timely::logging_core::Registry

pub struct Registry<Id> { /* private fields */ }

Implementations

impl<Id> Registry<Id>

where Id: Clone + 'static,

pub fn insert<T, F>(&mut self, name: &str, action: F) -> Option<Box<dyn Any>>

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

Binds a log name to an action on log event batches.

This method also returns any pre-installed action, rather than overwriting it and pivoting the logging destination mid-stream. New loggers with this name will use the new destination, and existing loggers will use the old destination.

The action should respond to a sequence of events with non-decreasing timestamps (Durations) and well as a timestamp that lower bounds the next event that could be seen (likely greater or equal to the timestamp of the last event). The end of a logging stream is indicated only by dropping the associated action, which can be accomplished with remove (or a call to insert, though this is not recommended).

pub fn insert_logger<T>( &mut self, name: &str, logger: Logger<T, Id>, ) -> Option<Box<dyn Any>>

where T: 'static,

Binds a log name to a logger.

pub fn remove(&mut self, name: &str) -> Option<Box<dyn Any>>

Removes a bound logger.

This is intended primarily to close a logging stream and let the associated writer communicate that the stream is closed to any consumers. If a binding is not removed, then the stream cannot be complete as in principle anyone could acquire a handle to the logger and start further logging.

pub fn get<T>(&self, name: &str) -> Option<Logger<T, Id>>

where T: 'static,

Retrieves a shared logger, if one has been inserted.

pub fn new(time: Instant, id: Id) -> Registry<Id>

Creates a new logger registry.

pub fn flush(&mut self)

Flushes all registered logs.