Struct AsyncFd

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

A wrapper for IO source, providing implementations for AsyncRead and AsyncWrite.

Implementations

impl<T: AsRawFd> AsyncFd<T>

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

Create AsyncFd and attach the source to the current runtime.

pub unsafe fn new_unchecked(source: T) -> Self

Create AsyncFd without attaching the source.

Safety

The user should handle the attachment correctly.

Trait Implementations

impl<T: AsRawFd> AsRawFd for AsyncFd<T>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<T: AsRawFd + 'static> AsyncRead for &AsyncFd<T>

async fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>

Read some bytes from this source into the IoBufMut buffer and return a BufResult, consisting of the buffer and a usize indicating how many bytes were read.

async fn read_vectored<V: IoVectoredBufMut>( &mut self, buf: V, ) -> BufResult<usize, V>

Like read, except that it reads into a type implements IoVectoredBufMut.

impl<T: AsRawFd + 'static> AsyncRead for AsyncFd<T>

async fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>

Read some bytes from this source into the IoBufMut buffer and return a BufResult, consisting of the buffer and a usize indicating how many bytes were read.

async fn read_vectored<V: IoVectoredBufMut>( &mut self, buf: V, ) -> BufResult<usize, V>

Like read, except that it reads into a type implements IoVectoredBufMut.

impl<T: AsRawFd + 'static> AsyncWrite for &AsyncFd<T>

async fn write<B: IoBuf>(&mut self, buf: B) -> BufResult<usize, B>

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn write_vectored<V: IoVectoredBuf>( &mut self, buf: V, ) -> BufResult<usize, V>

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

async fn flush(&mut self) -> Result<()>

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

async fn shutdown(&mut self) -> Result<()>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl<T: AsRawFd + 'static> AsyncWrite for AsyncFd<T>

async fn write<B: IoBuf>(&mut self, buf: B) -> BufResult<usize, B>

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn write_vectored<V: IoVectoredBuf>( &mut self, buf: V, ) -> BufResult<usize, V>

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

async fn flush(&mut self) -> Result<()>

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

async fn shutdown(&mut self) -> Result<()>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl<T: AsRawFd> Clone for AsyncFd<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: AsRawFd + FromRawFd> FromRawFd for AsyncFd<T>

Available on Unix only.

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl<T: AsRawFd> IntoInner for AsyncFd<T>

type Inner = SharedFd<T>

The inner type.

fn into_inner(self) -> Self::Inner

Get the inner buffer.

impl<T: AsRawFd> ToSharedFd<T> for AsyncFd<T>

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

Return a cloned SharedFd.