Struct EventStream 

pub struct EventStream<I: Input> { /* private fields */ }

A thread-backed [futures_core::Stream] of io::Result<Event> over a shared EventSource.

Build one with EventSource::into_stream (sole owner) or EventStream::from_shared (sharing a source kept elsewhere). A helper thread blocks in EventSource::poll, which reads and decodes input into the source’s queue, then wakes the polling task; the task drains queued events (and may itself decode via a non-blocking poll). The stream yields Some(Ok(event)) per decoded event and, once, Some(Err(_)) on a read error or end-of-input, then fuses to None. Dropping it ends the helper thread; the shared source is left intact for any other holder.

Implementations

impl<I> EventStream<I>

where I: Input + 'static,

pub fn from_shared(source: Arc<Mutex<EventSource<I>>>) -> Self

Build a stream over a source shared via Arc<Mutex<_>>.

The caller may keep its own clone of the Arc to read the source synchronously while the stream is live (see the coexistence caveats on this module).

Trait Implementations

impl<I: Input> Drop for EventStream<I>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<I: Input> Stream for EventStream<I>

type Item = Result<Event, Error>

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.