Skip to main content

CompositeObserver

Struct CompositeObserver 

Source
pub struct CompositeObserver { /* private fields */ }
Expand description

Fans every signal out to several observers, in registration order.

use std::sync::Arc;

use turnframe_core::observe::{Observer, Signal};
use turnframe_telemetry::{CompositeObserver, MetricsObserver, RecordingObserver};

let recorder = Arc::new(RecordingObserver::new());
let observer = CompositeObserver::new()
    .with(MetricsObserver::new())
    .with_shared(Arc::clone(&recorder));

observer.observe(&Signal::TurnReceived);
assert_eq!(recorder.count(Signal::TurnReceived), 1);

Implementations§

Source§

impl CompositeObserver

Source

pub fn new() -> Self

An empty composite. Signals given to it go nowhere.

Source

pub fn with(self, observer: impl Observer + 'static) -> Self

Adds an observer, taking ownership of it.

Source

pub fn with_shared<O: Observer + 'static>(self, observer: Arc<O>) -> Self

Adds an observer the caller keeps a handle to, which is what a test needs in order to inspect a RecordingObserver afterwards.

Generic over the concrete observer so Arc::clone(&handle) can be passed straight in; use CompositeObserver::push for a handle that is already erased to Arc<dyn Observer>.

Source

pub fn push(&mut self, observer: Arc<dyn Observer>)

Adds an already-erased observer to an existing composite, for a registry assembled at run time.

Source

pub fn len(&self) -> usize

How many observers are registered.

Source

pub fn is_empty(&self) -> bool

Returns true when no observer is registered.

Trait Implementations§

Source§

impl Clone for CompositeObserver

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompositeObserver

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CompositeObserver

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Observer for CompositeObserver

Source§

fn observe(&self, signal: &Signal)

Observes a signal without labels.
Source§

fn observe_labeled(&self, signal: &Signal, labels: &SignalLabels)

Observes a signal with labels. The default drops the labels.
Source§

fn observe_duration( &self, signal: &Signal, duration: Duration, labels: &SignalLabels, )

Observes a duration signal (SignalKind::DurationMillis or SignalKind::DurationMicros) with its measured value. The default drops the value and forwards to Observer::observe_labeled.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more