Struct AsyncFd 

pub struct AsyncFd<T: AsFd> { /* private fields */ }

A caller’s own descriptor, driven by readiness.

Implementations

impl<T: AsFd> AsyncFd<T>

pub fn new(inner: T) -> Result<Self>

Drives inner by readiness for reading and writing both.

Errors

Never today: the descriptor registers with the shard that first waits on it, and a poller that refuses it (a regular file, on epoll) says so at that wait.

pub fn with_interest(inner: T, interest: Interest) -> Result<Self>

Drives inner by readiness for what interest names.

Errors

As new.

pub fn get_ref(&self) -> &T

The descriptor.

pub fn get_mut(&mut self) -> &mut T

The descriptor, to change.

pub fn into_inner(self) -> T

The descriptor back, no longer watched.

pub fn poll_read_ready<'a>( &'a self, cx: &mut Context<'_>, ) -> Poll<Result<AsyncFdReadyGuard<'a, T>>>

Polls until the descriptor may be readable.

Errors

When the descriptor cannot be watched.

pub fn poll_write_ready<'a>( &'a self, cx: &mut Context<'_>, ) -> Poll<Result<AsyncFdReadyGuard<'a, T>>>

Polls until the descriptor may be writable.

Errors

When the descriptor cannot be watched.

pub async fn readable(&self) -> Result<AsyncFdReadyGuard<'_, T>>

Waits until the descriptor may be readable.

Errors

When the descriptor cannot be watched.

pub async fn writable(&self) -> Result<AsyncFdReadyGuard<'_, T>>

Waits until the descriptor may be writable.

Errors

When the descriptor cannot be watched.

pub async fn ready( &self, interest: Interest, ) -> Result<AsyncFdReadyGuard<'_, T>>

Waits until some of interest may be ready.

Errors

When the descriptor cannot be watched, and InvalidInput when it is not watched for any of interest.

pub async fn readable_mut(&mut self) -> Result<AsyncFdReadyMutGuard<'_, T>>

As readable, with the descriptor borrowed mutably.

Errors

When the descriptor cannot be watched.

pub async fn writable_mut(&mut self) -> Result<AsyncFdReadyMutGuard<'_, T>>

As writable, with the descriptor borrowed mutably.

Errors

When the descriptor cannot be watched.

pub async fn ready_mut( &mut self, interest: Interest, ) -> Result<AsyncFdReadyMutGuard<'_, T>>

As ready, with the descriptor borrowed mutably.

Errors

When the descriptor cannot be watched.

pub async fn async_io<R>( &self, interest: Interest, f: impl FnMut(&T) -> Result<R>, ) -> Result<R>

Runs f on the descriptor each time some of interest may be ready, until it answers other than WouldBlock, clearing the readiness each time it does.

Errors

What f answers, when the descriptor cannot be watched, and InvalidInput when it is not watched for any of interest.

pub fn try_io<R>( &self, interest: Interest, f: impl FnOnce(&T) -> Result<R>, ) -> Result<R>

Runs f on the descriptor now if some of interest may be ready, clearing that readiness if it answers WouldBlock.

Errors

WouldBlock when none of interest may be ready, InvalidInput when the descriptor is not watched for any of it, and what f answers.

Trait Implementations

impl<T: AsFd + Debug> Debug for AsyncFd<T>

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

Formats the value using the given formatter.