Struct Runtime 

pub struct Runtime<TEmitter = Empty, TFilter = Empty, TCtxt = Empty, TClock = Empty, TRng = Empty> { /* private fields */ }

A diagnostic pipeline.

Each runtime includes the following components:

• An Emitter to receive diagnostic events.
• A Filter to limit the volume of diagnostic events.
• A Ctxt to capture and attach ambient state to events.
• A Clock to timestamp events.
• A Rng to generate correlation ids for events.

The components of a runtime can be accessed directly through methods. A runtime can be treated like a builder to set its components, or initialized with them all directly.

In statics, you can also use the AmbientSlot type to hold a type-erased runtime. It’s also reasonable to store a fully generic runtime in a static too.

Implementations

impl Runtime

pub const fn new() -> Runtime

Create a new, empty runtime.

impl<TEmitter, TFilter, TCtxt, TClock, TRng> Runtime<TEmitter, TFilter, TCtxt, TClock, TRng>

pub const fn build( emitter: TEmitter, filter: TFilter, ctxt: TCtxt, clock: TClock, rng: TRng, ) -> Self

Create a new runtime with the given components.

pub const fn emitter(&self) -> &TEmitter

Get the Emitter.

pub fn with_emitter<U>( self, emitter: U, ) -> Runtime<U, TFilter, TCtxt, TClock, TRng>

Set the Emitter.

pub fn map_emitter<U>( self, emitter: impl FnOnce(TEmitter) -> U, ) -> Runtime<U, TFilter, TCtxt, TClock, TRng>

Map the current Emitter to a new value.

pub const fn filter(&self) -> &TFilter

Get the Filter.

pub fn with_filter<U>( self, filter: U, ) -> Runtime<TEmitter, U, TCtxt, TClock, TRng>

Set the Filter.

pub fn map_filter<U>( self, filter: impl FnOnce(TFilter) -> U, ) -> Runtime<TEmitter, U, TCtxt, TClock, TRng>

Map the current Filter to a new value.

pub const fn ctxt(&self) -> &TCtxt

Get the Ctxt.

pub fn with_ctxt<U>( self, ctxt: U, ) -> Runtime<TEmitter, TFilter, U, TClock, TRng>

Set the Ctxt.

pub fn map_ctxt<U>( self, ctxt: impl FnOnce(TCtxt) -> U, ) -> Runtime<TEmitter, TFilter, U, TClock, TRng>

Map the current Ctxt to a new value.

pub const fn clock(&self) -> &TClock

Get the Clock.

pub fn with_clock<U>( self, clock: U, ) -> Runtime<TEmitter, TFilter, TCtxt, U, TRng>

Set the Clock.

pub fn map_clock<U>( self, clock: impl FnOnce(TClock) -> U, ) -> Runtime<TEmitter, TFilter, TCtxt, U, TRng>

Map the current Clock to a new value.

pub const fn rng(&self) -> &TRng

Get the Rng.

pub fn with_rng<U>( self, id_gen: U, ) -> Runtime<TEmitter, TFilter, TCtxt, TClock, U>

Set the Rng.

pub fn map_rng<U>( self, id_gen: impl FnOnce(TRng) -> U, ) -> Runtime<TEmitter, TFilter, TCtxt, TClock, U>

Map the current Rng to a new value.

impl<TEmitter: Emitter, TFilter: Filter, TCtxt: Ctxt, TClock: Clock, TRng: Rng> Runtime<TEmitter, TFilter, TCtxt, TClock, TRng>

pub fn emit<E: ToEvent>(&self, evt: E)

Emit a diagnostic event through the runtime.

This method uses the components of the runtime to process the event. It will:

1. Attempt to assign an extent to the event using Clock::now if the event doesn’t already have one.
2. Add Ctxt::Current to the event properties.
3. Ensure the event passes Filter::matches.
4. Emit the event through Emitter::emit.

You can bypass any of these steps by emitting the event directly through the runtime’s Emitter.

pub fn blocking_flush(&self, timeout: Duration) -> bool

Block for up to timeout, waiting for all diagnostic data emitted up to this point to be fully processed.

This method defers to the runtime’s Emitter::blocking_flush.

Trait Implementations

impl<TEmitter: Clone, TFilter: Clone, TCtxt: Clone, TClock: Clone, TRng: Clone> Clone for Runtime<TEmitter, TFilter, TCtxt, TClock, TRng>

fn clone(&self) -> Runtime<TEmitter, TFilter, TCtxt, TClock, TRng>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TEmitter: Debug, TFilter: Debug, TCtxt: Debug, TClock: Debug, TRng: Debug> Debug for Runtime<TEmitter, TFilter, TCtxt, TClock, TRng>

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

Formats the value using the given formatter.

impl Default for Runtime

fn default() -> Self

Returns the “default value” for a type.

impl<TEmitter: Emitter, TFilter: Filter, TCtxt: Ctxt, TClock: Clock, TRng: Rng> Emitter for Runtime<TEmitter, TFilter, TCtxt, TClock, TRng>

fn emit<E: ToEvent>(&self, evt: E)

Emit an Event.

fn blocking_flush(&self, timeout: Duration) -> bool

Block for up to timeout, waiting for all diagnostic data emitted up to this point to be fully processed.

fn and_to<U>(self, other: U) -> And<Self, U>

where Self: Sized,

Emit events to both self and other.

fn wrap_emitter<W: Wrapping>(self, wrapping: W) -> Wrap<Self, W>

where Self: Sized,

Wrap the emitter, transforming or filtering Events before it receives them.

impl<TEmitter: Copy, TFilter: Copy, TCtxt: Copy, TClock: Copy, TRng: Copy> Copy for Runtime<TEmitter, TFilter, TCtxt, TClock, TRng>