Struct pal_async::wait::PolledWait

pub struct PolledWait<T> { /* private fields */ }

A polled wait object.

Implementations

impl<T: AsFd> PolledWait<T>

pub fn new(driver: &(impl ?Sized + Driver), event: T) -> Result<Self>

Returns a new polled wait object wrapping event.

Typically T will be pal_event::Event. The read size for consuming the fd’s signal will be 8 bytes to match the behavior of eventfd.

pub fn new_with_size( driver: &(impl ?Sized + Driver), event: T, read_size: usize, ) -> Result<Self>

Returns a new polled wait object wrapping event, with a specific sized read to consume the event.

impl<T> PolledWait<T>

pub fn into_inner(self) -> T

Returns the inner wait object.

With some drivers, this may leak a signal.

pub fn get(&self) -> &T

Gets a reference to the inner wait object.

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

Polls for the wait object to be signaled.

pub fn wait(&mut self) -> impl '_ + Unpin + Future<Output = Result<()>>

Waits for the wait object to be signaled.

Trait Implementations

impl<T: Debug> Debug for PolledWait<T>

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

Formats the value using the given formatter.