Struct ConnectionEvents 

pub struct ConnectionEvents<S> { /* private fields */ }

Stream wrapper for observing connection lifecycle events.

Concrete SDK clients can wrap their runtime-specific event stream in this type while exposing a stable SDK item type of ConnectionEvent.

Implementations

impl<S> ConnectionEvents<S>

pub const fn new(inner: S) -> Self

Wraps a stream that yields connection transition events.

pub const fn inner(&self) -> &S

Returns a shared reference to the wrapped stream.

pub fn into_inner(self) -> S

Unwraps the runtime-specific event stream.

Trait Implementations

impl<S: Clone> Clone for ConnectionEvents<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for ConnectionEvents<S>

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

Formats the value using the given formatter.

impl<S> Stream for ConnectionEvents<S>

where S: Stream<Item = ConnectionEvent> + Unpin,

type Item = ConnectionEvent

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, context: &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.