Struct DynInstrumentation

#[non_exhaustive]
pub struct DynInstrumentation { /* private fields */ }

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

An optional dyn instrumentation.

For ease of use, this type implements Deref and DerefMut to &dyn Instrumentation, falling back to a no-op implementation if no instrumentation is set.

The DynInstrumentation type is useful because without it we actually did tend to return (accidentally) &mut Option as &mut dyn Instrumentation from connection.instrumentation(), so downcasting would have to be done in these two steps by the user, which is counter-intuitive.

Implementations

impl DynInstrumentation

pub fn default_instrumentation() -> Self

Create a instance of the default instrumentation provider

pub fn none() -> Self

Create a noop instrumentation provider instance

pub fn on_connection_event(&mut self, event: InstrumentationEvent<'_>)

register an event with the given instrumentation implementation

Methods from Deref<Target = dyn Instrumentation>

pub fn is<__T: Instrumentation>(&self) -> bool

Returns true if the trait object wraps an object of type __T.

pub fn downcast_rc<__T: Instrumentation>( self: Rc<Self>, ) -> Result<Rc<__T>, Rc<Self>>

Returns an Rc-ed object from an Rc-ed trait object if the underlying object is of type __T. Returns the original Rc-ed trait if it isn’t.

pub fn downcast_ref<__T: Instrumentation>(&self) -> Option<&__T>

Returns a reference to the object within the trait object if it is of type __T, or None if it isn’t.

pub fn downcast_mut<__T: Instrumentation>(&mut self) -> Option<&mut __T>

Returns a mutable reference to the object within the trait object if it is of type __T, or None if it isn’t.

Trait Implementations

impl Deref for DynInstrumentation

type Target = dyn Instrumentation

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DynInstrumentation

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<I: Instrumentation> From<I> for DynInstrumentation

fn from(instrumentation: I) -> Self

Converts to this type from the input type.