Struct s2n_quic_transport::stream::StreamEvents

pub struct StreamEvents {
    pub read_wake: Option<Waker>,
    pub write_wake: Option<Waker>,
}

Events that are triggered through a state-update on a Stream. E.g. retrieving new data can unblock readers, which is signalled via this Event.

Fields

read_wake: Option<Waker>

A task that is waiting on the reading half of the Stream that might have been woken up due to an action.

write_wake: Option<Waker>

A task that is waiting on the writing half of the Stream that might have been woken up due to an action.

Implementations

impl StreamEvents

pub fn new() -> StreamEvents

Creates a new StreamEvents instance with no pending events

pub fn waker_count(&self) -> usize

Returns the amount of Waker instances that are stored in the event

pub fn store_read_waker(&mut self, waker: Waker)

Stores a Waker which was waiting on the reading half of the Stream to get ready. The Waker will get woken up by the consumer of StreamEvents.

pub fn store_write_waker(&mut self, waker: Waker)

Stores a Waker which was waiting on the writing half of the Stream to get ready. The Waker will get woken up by the consumer of StreamEvents.

pub fn wake_all(&mut self)

Wakes all Waker instances that have been stored via add_waker. Waking the Wakers will remove them from the StreamEventss struct.

Trait Implementations

impl Debug for StreamEvents

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

Formats the value using the given formatter.

impl Default for StreamEvents

fn default() -> StreamEvents

Returns the “default value” for a type.