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<Self, 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) -> Self

Convenience constructor for one observer.

Examples found in repository?
examples/observe_tokens.rs (line 20)
18fn main() -> Result<(), Box<dyn std::error::Error>> {
19    let implementation = Digest::of_bytes("example-observer", b"byte-counter-v1");
20    let mut observers = ObserverSet::single(implementation, ByteCounter);
21    observers.begin(10, 2)?;
22
23    observers.poll()?;
24    observers.observe(ObservedToken {
25        token: TokenId::new(7)?,
26        piece: &[0xff, 0x00],
27        position: 11,
28    })?;
29
30    let receipt = observers
31        .receipt(0)
32        .ok_or("single observer receipt is missing")?;
33    assert_eq!(receipt.observed_tokens, 1);
34    assert_eq!(receipt.observed_bytes, 2);
35    println!("observer receipt: {}", receipt.digest()?);
36    Ok(())
37}
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.

Examples found in repository?
examples/observe_tokens.rs (line 21)
18fn main() -> Result<(), Box<dyn std::error::Error>> {
19    let implementation = Digest::of_bytes("example-observer", b"byte-counter-v1");
20    let mut observers = ObserverSet::single(implementation, ByteCounter);
21    observers.begin(10, 2)?;
22
23    observers.poll()?;
24    observers.observe(ObservedToken {
25        token: TokenId::new(7)?,
26        piece: &[0xff, 0x00],
27        position: 11,
28    })?;
29
30    let receipt = observers
31        .receipt(0)
32        .ok_or("single observer receipt is missing")?;
33    assert_eq!(receipt.observed_tokens, 1);
34    assert_eq!(receipt.observed_bytes, 2);
35    println!("observer receipt: {}", receipt.digest()?);
36    Ok(())
37}
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.

Examples found in repository?
examples/observe_tokens.rs (line 23)
18fn main() -> Result<(), Box<dyn std::error::Error>> {
19    let implementation = Digest::of_bytes("example-observer", b"byte-counter-v1");
20    let mut observers = ObserverSet::single(implementation, ByteCounter);
21    observers.begin(10, 2)?;
22
23    observers.poll()?;
24    observers.observe(ObservedToken {
25        token: TokenId::new(7)?,
26        piece: &[0xff, 0x00],
27        position: 11,
28    })?;
29
30    let receipt = observers
31        .receipt(0)
32        .ok_or("single observer receipt is missing")?;
33    assert_eq!(receipt.observed_tokens, 1);
34    assert_eq!(receipt.observed_bytes, 2);
35    println!("observer receipt: {}", receipt.digest()?);
36    Ok(())
37}
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.

Examples found in repository?
examples/observe_tokens.rs (lines 24-28)
18fn main() -> Result<(), Box<dyn std::error::Error>> {
19    let implementation = Digest::of_bytes("example-observer", b"byte-counter-v1");
20    let mut observers = ObserverSet::single(implementation, ByteCounter);
21    observers.begin(10, 2)?;
22
23    observers.poll()?;
24    observers.observe(ObservedToken {
25        token: TokenId::new(7)?,
26        piece: &[0xff, 0x00],
27        position: 11,
28    })?;
29
30    let receipt = observers
31        .receipt(0)
32        .ok_or("single observer receipt is missing")?;
33    assert_eq!(receipt.observed_tokens, 1);
34    assert_eq!(receipt.observed_bytes, 2);
35    println!("observer receipt: {}", receipt.digest()?);
36    Ok(())
37}
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.

Examples found in repository?
examples/observe_tokens.rs (line 31)
18fn main() -> Result<(), Box<dyn std::error::Error>> {
19    let implementation = Digest::of_bytes("example-observer", b"byte-counter-v1");
20    let mut observers = ObserverSet::single(implementation, ByteCounter);
21    observers.begin(10, 2)?;
22
23    observers.poll()?;
24    observers.observe(ObservedToken {
25        token: TokenId::new(7)?,
26        piece: &[0xff, 0x00],
27        position: 11,
28    })?;
29
30    let receipt = observers
31        .receipt(0)
32        .ok_or("single observer receipt is missing")?;
33    assert_eq!(receipt.observed_tokens, 1);
34    assert_eq!(receipt.observed_bytes, 2);
35    println!("observer receipt: {}", receipt.digest()?);
36    Ok(())
37}

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, 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, 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.