Struct ItemListenerSet 

pub struct ItemListenerSet<I, O> { /* private fields */ }

A bounded, ordered registration of the M3 item listener families.

use std::sync::Arc;

use oxide_batch::{
    BoxFuture, ItemListenerContext, ItemListenerSet, ListenerError, ReadListener,
};

struct AuditReads;

impl ReadListener<u32> for AuditReads {
    fn after_read<'a>(
        &'a self,
        item: &'a u32,
        _context: ItemListenerContext<'a>,
    ) -> BoxFuture<'a, Result<(), ListenerError>> {
        let accepted = *item < 1_000;
        Box::pin(async move {
            if accepted {
                Ok(())
            } else {
                Err(ListenerError::new())
            }
        })
    }
}

let listeners = ItemListenerSet::<u32, String>::new()
    .with_read_listener(Arc::new(AuditReads))?;
assert_eq!(listeners.read_listeners(), 1);

Implementations

impl<I, O> ItemListenerSet<I, O>

pub const MAX_LISTENERS: usize = MAX_LISTENERS

The largest accepted number of listeners in one family.

pub fn new() -> Self

Constructs an empty registration.

pub fn with_read_listener( self, listener: Arc<dyn ReadListener<I>>, ) -> Result<Self, ItemListenerError>

Registers one read listener.

Errors

Returns ItemListenerError::TooManyListeners beyond the bound.

pub fn with_process_listener( self, listener: Arc<dyn ProcessListener<I, O>>, ) -> Result<Self, ItemListenerError>

Registers one process listener.

Errors

Returns ItemListenerError::TooManyListeners beyond the bound.

pub fn with_write_listener( self, listener: Arc<dyn WriteListener<O>>, ) -> Result<Self, ItemListenerError>

Registers one write listener.

Errors

Returns ItemListenerError::TooManyListeners beyond the bound.

pub fn with_retry_listener( self, listener: Arc<dyn RetryListener>, ) -> Result<Self, ItemListenerError>

Registers one retry listener.

Errors

Returns ItemListenerError::TooManyListeners beyond the bound.

pub fn with_skip_listener( self, listener: Arc<dyn SkipListener<I, O>>, ) -> Result<Self, ItemListenerError>

Registers one skip listener.

Errors

Returns ItemListenerError::TooManyListeners beyond the bound.

pub fn is_empty(&self) -> bool

Returns whether no listener is registered.

pub fn read_listeners(&self) -> usize

Returns the number of registered read listeners.

pub fn process_listeners(&self) -> usize

Returns the number of registered process listeners.

pub fn write_listeners(&self) -> usize

Returns the number of registered write listeners.

pub fn retry_listeners(&self) -> usize

Returns the number of registered retry listeners.

pub fn skip_listeners(&self) -> usize

Returns the number of registered skip listeners.

impl<I, O> ItemListenerSet<I, O>

where I: Sync, O: Sync,

The callback passes borrow items across await, so both item types must be shareable. Registration and inspection remain available for any item type.

pub async fn before_read( &self, context: ItemListenerContext<'_>, ) -> BeforeCallbackOutcome

Runs read before-callbacks in registration order.

pub async fn after_read( &self, entered: usize, item: &I, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs read after-callbacks for entered listeners in reverse order.

pub async fn on_read_error( &self, entered: usize, fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs read error callbacks for entered listeners in reverse order.

pub async fn before_process( &self, input: &I, context: ItemListenerContext<'_>, ) -> BeforeCallbackOutcome

Runs process before-callbacks in registration order.

pub async fn after_process( &self, entered: usize, input: &I, output: Option<&O>, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs process after-callbacks for entered listeners in reverse order.

pub async fn on_process_error( &self, entered: usize, input: &I, fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs process error callbacks for entered listeners in reverse order.

pub async fn before_write( &self, outputs: &[O], context: ItemListenerContext<'_>, ) -> BeforeCallbackOutcome

Runs write before-callbacks in registration order.

pub async fn after_write( &self, entered: usize, outputs: &[O], context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs write after-callbacks for entered listeners in reverse order.

pub async fn on_write_error( &self, entered: usize, outputs: &[O], fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs write error callbacks for entered listeners in reverse order.

pub async fn before_retry( &self, fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> BeforeCallbackOutcome

Runs retry before-callbacks in registration order.

pub async fn after_retry( &self, entered: usize, fault: FaultDescriptor, outcome: RetryOutcome, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs retry completion callbacks for entered listeners in reverse order.

pub async fn on_retry_exhausted( &self, entered: usize, fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Runs retry exhaustion callbacks for entered listeners in reverse order.

pub async fn on_skip_in_read( &self, fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Confirms a skipped read in registration order.

pub async fn on_skip_in_process( &self, input: &I, fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Confirms a skipped input in registration order.

pub async fn on_skip_in_write( &self, output: &O, fault: FaultDescriptor, context: ItemListenerContext<'_>, ) -> Vec<ItemListenerFailure>

Confirms a skipped output in registration order.

Trait Implementations

impl<I, O> Clone for ItemListenerSet<I, O>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I, O> Debug for ItemListenerSet<I, O>

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

Formats the value using the given formatter.

impl<I, O> Default for ItemListenerSet<I, O>

fn default() -> Self

Returns the “default value” for a type.