Struct Waiter 

pub struct Waiter<'a> { /* private fields */ }

A waiter registered for a tag of the I/O stream.

The waiter and poll_ready complete once IoRef::wake is called for the tag, all waiters of the tag are woken together. They also complete once the I/O stream is closed. The first poll registers the waiter, a wake is reported to a registered waiter even if it happens between polls, once reported the next poll registers again. A waiter that is not registered misses the wake. Dropping the waiter releases its registration.

Implementations

impl<'a> Waiter<'a>

pub fn new(io: &'a IoRef, tag: usize) -> Waiter<'a>

Creates a waiter for the tag.

Panics

Panics in debug builds if the tag is reserved for internal use, usize::MAX - 1 and usize::MAX - 2 are reserved.

pub fn poll_ready(&self, cx: &mut Context<'_>) -> Poll<()>

Polls until the tag is woken.

Completes once the I/O stream is closed.

pub fn into_static(self) -> Waiter<'static>

Converts the waiter into one that owns its IoRef.

The registration of the waiter is kept.

Trait Implementations

impl Clone for Waiter<'_>

fn clone(&self) -> Waiter<'_>

Creates an unregistered waiter for the same tag.

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

Performs copy-assignment from source.

impl<'a> Debug for Waiter<'a>

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

Formats the value using the given formatter.

impl Drop for Waiter<'_>

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 Future for Waiter<'_>

type Output = ()

The type of value produced on completion.

fn poll( self: Pin<&mut Waiter<'_>>, cx: &mut Context<'_>, ) -> Poll<<Waiter<'_> as Future>::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.