Struct LogContext 

pub struct LogContext { /* private fields */ }

A log context saves informations about the current task, such as the elapsed time, the number of polls, and the poll time.

Implementations

impl LogContext

pub fn new(tag: impl Into<Cow<'static, str>>) -> Self

Create a new log context with the given tag

pub fn tag(&self) -> &Cow<'static, str>

Get the tag of the log context

pub fn maybe_with<F, R>(f: F) -> Option<R>

where F: FnOnce(&Self) -> R,

Run a closure with the current log context, if any

pub fn run<F: FnOnce() -> Fut, Fut: Future>( &self, f: F, ) -> LogContextFuture<Fut>

Run the async function f with the given log context. It will wrap the output future to record poll and CPU statistics.

pub fn run_sync<F: FnOnce() -> R, R>(&self, f: F) -> R

Run the sync function f with the given log context, recording the CPU time spent.

pub fn maybe_record_query_stats(fetched: usize, duration: Duration)

Record the stats of a query on the current log context.

pub fn record_query_stats(&self, fetched: usize, duration: Duration)

Record the stats of a query

pub fn set_requester(&self, requester: Requester)

Associate a Requester with this log context. Silently does nothing if a requester has already been recorded (first writer wins).

pub fn requester(&self) -> Option<&Requester>

Get the Requester associated with this log context, if one was set.

pub fn maybe_set_requester(requester: Requester)

Convenience: set the Requester on the current task-local LogContext, if one exists. No-op outside of a LogContext scope.

pub fn stats(&self) -> LogContextStats

Create a snapshot of the log context statistics

Trait Implementations

impl Clone for LogContext

fn clone(&self) -> LogContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for LogContext

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

Formats the value using the given formatter.