Struct EventIterator 

pub struct EventIterator { /* private fields */ }

Main event iterator that provides both sync and async interfaces

Implementations

impl EventIterator

pub fn new(receiver: UnboundedReceiver<EnrichedEvent>) -> Self

Create a new event iterator

pub async fn next_async(&mut self) -> Option<EnrichedEvent>

ASYNC INTERFACE - Get the next event asynchronously Best for real-time event processing where you want to handle events as they arrive

pub async fn next_timeout( &mut self, timeout_duration: Duration, ) -> EventProcessingResult<Option<EnrichedEvent>>

ASYNC INTERFACE - Get next event with timeout

pub fn try_next(&mut self) -> EventProcessingResult<Option<EnrichedEvent>>

ASYNC INTERFACE - Try to get next event without blocking

pub fn iter(&mut self) -> SyncEventIterator<'_>

SYNC INTERFACE - Get iterator for simple loop patterns BEST PRACTICE for local state management

This is the recommended interface for maintaining local state from events. Use like: for event in events.iter() { /* handle event */ }

pub async fn next_batch( &mut self, max_count: usize, max_wait: Duration, ) -> Vec<EnrichedEvent>

Buffer multiple events for batch processing

pub fn stats(&self) -> &EventIteratorStats

Get iterator statistics

pub fn is_consumed(&self) -> bool

Check if the iterator has been consumed (channel closed)

pub async fn peek(&mut self) -> Option<&EnrichedEvent>

Peek at the next event without consuming it

pub fn filter_by_registration( self, registration_id: RegistrationId, ) -> FilteredEventIterator

Filter events by registration ID

pub fn filter_by_service(self, service: Service) -> FilteredEventIterator

Filter events by service type

pub fn filter_by_source_type( self, source_type: EventSourceType, ) -> FilteredEventIterator

Filter events by source type (UPnP or polling)

Trait Implementations

impl Stream for EventIterator

Implement Stream trait for EventIterator for advanced async usage

type Item = EnrichedEvent

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.