pub struct ObserverSet { /* private fields */ }Expand description
Ordered observer fan-out behind one backend callback point.
Implementations§
Source§impl ObserverSet
impl ObserverSet
Sourcepub fn new(
observers: impl IntoIterator<Item = (Digest, Box<dyn Observer>)>,
) -> Result<Self, ObserverError>
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.
Sourcepub fn single(implementation: Digest, observer: impl Observer + 'static) -> Self
pub fn single(implementation: Digest, observer: impl Observer + 'static) -> Self
Convenience constructor for one observer.
Examples found in repository?
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}Sourcepub fn identity(&self) -> Result<Digest, ObserverError>
pub fn identity(&self) -> Result<Digest, ObserverError>
Returns the identity of the exact ordered observer implementations.
§Errors
Returns an error when identity serialization fails.
Sourcepub fn begin(
&mut self,
initial_position: u64,
requested_tokens: u32,
) -> Result<(), ObserverError>
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?
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}Sourcepub fn poll(&mut self) -> Result<ControlFlow, ObserverError>
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?
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}Sourcepub fn observe(
&mut self,
token: ObservedToken<'_>,
) -> Result<ControlFlow, ObserverError>
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?
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}Sourcepub fn receipts(&self) -> Vec<ObserverReceipt>
pub fn receipts(&self) -> Vec<ObserverReceipt>
Returns current per-observer accounting in dispatch order.
Sourcepub fn receipt(&self, index: usize) -> Option<&ObserverReceipt>
pub fn receipt(&self, index: usize) -> Option<&ObserverReceipt>
Returns one observer receipt by dispatch index.
Examples found in repository?
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}