Skip to main content

ObserverSet

Struct ObserverSet 

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

Ordered observer fan-out behind one backend callback point.

Implementations§

Source§

impl ObserverSet

Source

pub fn new( observers: impl IntoIterator<Item = (Digest, Box<dyn Observer>)>, ) -> Result<ObserverSet, ObserverError>

Creates a non-empty bounded observer set.

§Errors

Returns an error unless one to 16 observers are supplied and identities are unique.

Source

pub fn single( implementation: Digest, observer: impl Observer + 'static, ) -> ObserverSet

Convenience constructor for one observer.

Source

pub fn identity(&self) -> Result<Digest, ObserverError>

Returns the identity of the exact ordered observer implementations.

§Errors

Returns an error when identity serialization fails.

Source

pub fn begin( &mut self, initial_position: u64, requested_tokens: u32, ) -> Result<(), ObserverError>

Resets every observer for a new generation call.

§Errors

Returns a bounded error or panic from one observer.

Source

pub fn poll(&mut self) -> Result<ControlFlow, ObserverError>

Polls every observer in order before one sampling decision.

All observers run even after an earlier observer requests a stop. This gives every sink the same pre-sampling boundary. Poll count cannot exceed the token bound supplied to Self::begin.

§Errors

Returns a lifecycle or contained callback failure.

Source

pub fn observe( &mut self, token: ObservedToken<'_>, ) -> Result<ControlFlow, ObserverError>

Delivers one causally admitted token to every observer in order.

A successful poll must precede delivery, and delivery cannot exceed the token bound supplied to Self::begin.

§Errors

Returns a lifecycle or contained callback failure.

Source

pub fn receipts(&self) -> Vec<ObserverReceipt>

Returns current per-observer accounting in dispatch order.

Source

pub fn receipt(&self, index: usize) -> Option<&ObserverReceipt>

Returns one observer receipt by dispatch index.

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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<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