Struct PollFd 

pub struct PollFd<T: AsFd>(/* private fields */);

Providing functionalities to wait for readiness.

Implementations

impl<T: AsFd> PollFd<T>

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

Create PollFd without attaching the source.

Ready-based sources does not need to be attached.

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

Create PollFd from a shared file descriptor.

impl<T: AsFd + 'static> PollFd<T>

pub async fn accept_ready(&self) -> Result<()>

Wait for accept readiness, before calling accept, or after accept returns WouldBlock.

pub async fn connect_ready(&self) -> Result<()>

Wait for connect readiness.

pub async fn read_ready(&self) -> Result<()>

Wait for read readiness.

pub async fn write_ready(&self) -> Result<()>

Wait for write readiness.

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

Poll for accept readiness.

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

Poll for connect readiness.

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

Poll for read readiness.

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

Poll for write readiness.

pub fn poll_accept_with<R>( &self, cx: &mut Context<'_>, f: impl FnMut(&T) -> Result<R>, ) -> Poll<Result<R>>

Poll for accept readiness and call the provided function.

pub fn poll_read_with<R>( &self, cx: &mut Context<'_>, f: impl FnMut(&T) -> Result<R>, ) -> Poll<Result<R>>

Poll for read readiness and call the provided function.

pub fn poll_write_with<R>( &self, cx: &mut Context<'_>, f: impl FnMut(&T) -> Result<R>, ) -> Poll<Result<R>>

Poll for write readiness and call the provided function.

impl<T: AsFd + 'static> PollFd<T>

where for<'a> &'a T: Read,

pub fn poll_read( &self, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Poll for read readiness and read data.

pub fn poll_read_buf( &self, cx: &mut Context<'_>, buf: BorrowedCursor<'_, u8>, ) -> Poll<Result<()>>

Available on crate feature read_buf only.

Poll for read readiness and read data into an uninitialized buffer.

impl<T: AsFd + 'static> PollFd<T>

where for<'a> &'a T: Write,

pub fn poll_write( &self, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Poll for write readiness and write data.

pub fn poll_write_vectored( &self, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

Poll for write readiness and write data from a slice of buffers.

Whether this is more efficient than poll_write depends on the source: it is a single writev for sockets and files, while other sources may fall back to writing the first non-empty buffer.

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

Poll for write readiness and flush the source.

Trait Implementations

impl<T: AsFd> AsFd for PollFd<T>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<T: AsFd> AsRawFd for PollFd<T>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<T: AsFd + 'static> AsyncRead for &PollFd<T>

where for<'a> &'a T: Read,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<T: AsFd + 'static> AsyncRead for PollFd<T>

where for<'a> &'a T: Read,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<T: AsFd + 'static> AsyncWrite for &PollFd<T>

where for<'a> &'a T: Write,

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

impl<T: AsFd + 'static> AsyncWrite for PollFd<T>

where for<'a> &'a T: Write,

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

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

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

Formats the value using the given formatter.

impl<T: AsFd> Deref for PollFd<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: AsFd> IntoInner for PollFd<T>

type Inner = SharedFd<T>

The inner type.

fn into_inner(self) -> Self::Inner

Get the inner buffer.

impl<T: AsFd> ToSharedFd<T> for PollFd<T>

fn to_shared_fd(&self) -> SharedFd<T>

Return a cloned SharedFd.