Struct EventedFd

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

A type which can be used for receiving IO events for a file descriptor.

Implementations

impl<T> EventedFd<T>

where T: AsRawFd,

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

Creates a new EventedFd.

Safety

The raw file descriptor returned from inner.as_raw_fd() must not be closed until the returned EventedFd is dropped.

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

Tests to see if this resource is ready to be read from. If it is not, it arranges for the current task to receive a notification when a “readable” signal arrives.

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

Tests to see if this resource is ready to be written to. If it is not, it arranges for the current task to receive a notification when a “writable” signal arrives.

pub fn as_ref(&self) -> &T

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

pub fn need_read(&self, cx: &mut Context<'_>)

Arranges for the current task to receive a notification when a “readable” signal arrives.

pub fn need_write(&self, cx: &mut Context<'_>)

Arranges for the current task to receive a notification when a “writable” signal arrives.

pub fn clear(&self)

Clears all incoming signals.

Trait Implementations

impl<T: AsRawFd> AsRawFd for EventedFd<T>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<'a, T> AsyncRead for &'a EventedFd<T>

where T: AsRawFd, for<'b> &'b T: Read,

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

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: AsRawFd + Read> AsyncRead for EventedFd<T>

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

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<'a, T> AsyncWrite for &'a EventedFd<T>

where T: AsRawFd, for<'b> &'b T: Write,

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

Attempt to write bytes from buf into the object.

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

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

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

Attempt to close the object.

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

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

impl<T: AsRawFd + Write> AsyncWrite for EventedFd<T>

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

Attempt to write bytes from buf into the object.

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

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

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

Attempt to close the object.

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

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

impl<T: Debug> Debug for EventedFd<T>

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

Formats the value using the given formatter.

impl<T> Drop for EventedFd<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for EventedFd<T>

where T: Send,

impl<T> Sync for EventedFd<T>

where T: Sync,

impl<T> Unpin for EventedFd<T>