Struct Setup

pub struct Setup<TEmitter = DefaultEmitter, TFilter = DefaultFilter, TCtxt = DefaultCtxt> { /* private fields */ }

A configuration builder for an emit runtime.

Implementations

impl Setup

pub fn new() -> Self

Create a new builder with the default Emitter, Filter, and Ctxt.

impl<TEmitter: Emitter, TFilter: Filter, TCtxt: Ctxt> Setup<TEmitter, TFilter, TCtxt>

pub fn emit_to<UEmitter: Emitter>( self, emitter: UEmitter, ) -> Setup<UEmitter, TFilter, TCtxt>

Set the Emitter that will receive diagnostic events.

pub fn and_emit_to<UEmitter: Emitter>( self, emitter: UEmitter, ) -> Setup<And<TEmitter, UEmitter>, TFilter, TCtxt>

Add an Emitter that will also receive diagnostic events.

pub fn map_emitter<UEmitter: Emitter>( self, map: impl FnOnce(TEmitter) -> UEmitter, ) -> Setup<UEmitter, TFilter, TCtxt>

Map the current Emitter into a new value.

pub fn emit_when<UFilter: Filter>( self, filter: UFilter, ) -> Setup<TEmitter, UFilter, TCtxt>

Set the Filter that will be applied before diagnostic events are emitted.

pub fn and_emit_when<UFilter: Filter>( self, filter: UFilter, ) -> Setup<TEmitter, And<TFilter, UFilter>, TCtxt>

Add a Filter that will also be applied before diagnostic events are emitted.

pub fn with_ctxt<UCtxt: Ctxt>( self, ctxt: UCtxt, ) -> Setup<TEmitter, TFilter, UCtxt>

Set the Ctxt that will store ambient properties and attach them to diagnostic events.

pub fn map_ctxt<UCtxt: Ctxt>( self, map: impl FnOnce(TCtxt) -> UCtxt, ) -> Setup<TEmitter, TFilter, UCtxt>

Map the current Ctxt into a new value.

impl<TEmitter: Emitter + Send + Sync + 'static, TFilter: Filter + Send + Sync + 'static, TCtxt: Ctxt + Send + Sync + 'static> Setup<TEmitter, TFilter, TCtxt>

where TCtxt::Frame: Send + 'static,

pub fn init(self) -> Init<'static, TEmitter, TCtxt>

Initialize the default runtime used by emit macros.

This method initializes crate::runtime::shared.

Panics

This method will panic if the slot has already been initialized.

pub fn try_init(self) -> Option<Init<'static, TEmitter, TCtxt>>

Try initialize the default runtime used by emit macros.

This method initializes crate::runtime::shared.

If the slot is already initialized, this method will return None.

pub fn init_slot<'a>(self, slot: &'a AmbientSlot) -> Init<'a, TEmitter, TCtxt>

Initialize a runtime in the given static slot.

Panics

This method will panic if the slot has already been initialized.

pub fn try_init_slot<'a>( self, slot: &'a AmbientSlot, ) -> Option<Init<'a, TEmitter, TCtxt>>

Try initialize a runtime in the given static slot.

If the slot is already initialized, this method will return None.

impl<TEmitter: InternalEmitter + Send + Sync + 'static, TFilter: InternalFilter + Send + Sync + 'static, TCtxt: InternalCtxt + Send + Sync + 'static> Setup<TEmitter, TFilter, TCtxt>

where TCtxt::Frame: Send + 'static,

pub fn init_internal(self) -> Init<'static, TEmitter, TCtxt>

Initialize the internal runtime used for diagnosing runtimes themselves.

This method initializes crate::runtime::internal.

Panics

This method will panic if the slot has already been initialized.

pub fn try_init_internal(self) -> Option<Init<'static, TEmitter, TCtxt>>

Initialize the internal runtime used for diagnosing runtimes themselves.

This method initializes crate::runtime::internal.

If the slot is already initialized, this method will return None.

Trait Implementations

impl Default for Setup

fn default() -> Self

Returns the “default value” for a type.