Skip to main content

Receiver

Struct Receiver 

Source
pub struct Receiver { /* private fields */ }
Expand description

Consumer handle for the blocking event channel.

Not cloneable — single consumer. Provides blocking recv and recv_timeout in addition to non-blocking try_recv.

Blocking methods use a three-phase wait: fast poll → backoff (snooze) → park. The receiver parks when idle and is woken by the sender on new notifications.

Obtained from event_channel().

Implementations§

Source§

impl Receiver

Source

pub fn recv(&self, events: &mut Events)

Block until events are ready, then drain all into the buffer.

Three-phase wait: poll (fast path) → backoff (snooze) → park. Returns when at least one event is available.

Source

pub fn recv_limit(&self, events: &mut Events, limit: usize)

Block until events are ready, then drain up to limit.

Same three-phase wait. Returns when at least one event is available. Oldest notifications drain first (FIFO).

Source

pub fn recv_timeout(&self, events: &mut Events, timeout: Duration) -> bool

Block until events are ready, with timeout.

Returns true if events were received, false if the timeout elapsed with no events.

Source

pub fn recv_timeout_limit( &self, events: &mut Events, limit: usize, timeout: Duration, ) -> bool

Block until events are ready, with timeout and limit.

Returns true if events were received, false if the timeout elapsed with no events.

Source

pub fn try_recv(&self, events: &mut Events)

Non-blocking poll. Same as Poller::poll.

Source

pub fn try_recv_limit(&self, events: &mut Events, limit: usize)

Non-blocking poll with limit. Same as Poller::poll_limit.

Source

pub fn capacity(&self) -> usize

The maximum token index (exclusive).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.