Struct calloop::io::Async

pub struct Async<'l, F: AsFd> { /* private fields */ }

Adapter for async IO manipulations

This type wraps an IO object, providing methods to create futures waiting for its readiness.

If the futures-io cargo feature is enabled, it also implements AsyncRead and/or AsyncWrite if the underlying type implements Read and/or Write.

Note that this adapter and the futures procuded from it and not threadsafe.

Implementations

impl<'l, F: AsFd> Async<'l, F>

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

Mutably access the underlying IO object

pub fn readable<'s>(&'s mut self) -> Readable<'s, 'l, F>

A future that resolves once the object becomes ready for reading

pub fn writable<'s>(&'s mut self) -> Writable<'s, 'l, F>

A future that resolves once the object becomes ready for writing

pub fn into_inner(self) -> F

Remove the async adapter and retrieve the underlying object

Trait Implementations

impl<'l, F: AsFd + Read> AsyncRead for Async<'l, F>

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

Attempt to read from the AsyncRead into buf.

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

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

impl<'l, F: AsFd + Write> AsyncWrite for Async<'l, F>

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

Attempt to write bytes from buf into the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> TaskPoll<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<'_>) -> TaskPoll<Result<()>>

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

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

Attempt to close the object.

impl<'l, F: AsFd + Debug> Debug for Async<'l, F>

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

Formats the value using the given formatter.

impl<'l, F: AsFd> Drop for Async<'l, F>

fn drop(&mut self)

Executes the destructor for this type.

impl<'l, F: AsFd> Unpin for Async<'l, F>