Trait futures::io::AsyncWrite

pub trait AsyncWrite {
    fn poll_write(
        self: Pin<&mut Self>, 
        cx: &mut Context, 
        buf: &[u8]
    ) -> Poll<Result<usize, Error>>;
    fn poll_flush(
        self: Pin<&mut Self>, 
        cx: &mut Context
    ) -> Poll<Result<(), Error>>;
    fn poll_close(
        self: Pin<&mut Self>, 
        cx: &mut Context
    ) -> Poll<Result<(), Error>>;

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

Write bytes asynchronously.

This trait is analogous to the std::io::Write trait, but integrates with the asynchronous task system. In particular, the poll_write method, unlike Write::write, will automatically queue the current task for wakeup and return if data is not yet available, rather than blocking the calling thread.

Required methods

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.

On success, returns Poll::Ready(Ok(num_bytes_written)).

If the object is not ready for writing, the method returns Poll::Pending and arranges for the current task (via cx.waker().wake_by_ref()) to receive a notification when the object becomes writable or is closed.

Implementation

This function may not return errors of kind WouldBlock or Interrupted. Implementations must convert WouldBlock into Poll::Pending and either internally retry or convert Interrupted into another error kind.

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

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

On success, returns Poll::Ready(Ok(())).

If flushing cannot immediately complete, this method returns Poll::Pending and arranges for the current task (via cx.waker().wake_by_ref()) to receive a notification when the object can make progress towards flushing.

Implementation

This function may not return errors of kind WouldBlock or Interrupted. Implementations must convert WouldBlock into Poll::Pending and either internally retry or convert Interrupted into another error kind.

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

Attempt to close the object.

On success, returns Poll::Ready(Ok(())).

If closing cannot immediately complete, this function returns Poll::Pending and arranges for the current task (via cx.waker().wake_by_ref()) to receive a notification when the object can make progress towards closing.

Implementation

This function may not return errors of kind WouldBlock or Interrupted. Implementations must convert WouldBlock into Poll::Pending and either internally retry or convert Interrupted into another error kind.

Loading content...

Provided methods

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.

This method is similar to poll_write, but allows data from multiple buffers to be written using a single operation.

On success, returns Poll::Ready(Ok(num_bytes_written)).

If the object is not ready for writing, the method returns Poll::Pending and arranges for the current task (via cx.waker().wake_by_ref()) to receive a notification when the object becomes writable or is closed.

By default, this method delegates to using poll_write on the first buffer in bufs. Objects which support vectored IO should override this method.

Implementation

This function may not return errors of kind WouldBlock or Interrupted. Implementations must convert WouldBlock into Poll::Pending and either internally retry or convert Interrupted into another error kind.

Loading content...

Implementations on Foreign Types

impl<P> AsyncWrite for Pin<P> where
    P: DerefMut + Unpin,
    <P as Deref>::Target: AsyncWrite, 

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

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

fn poll_flush(
    self: Pin<&mut Pin<P>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut Pin<P>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl<T> AsyncWrite for Box<T> where
    T: AsyncWrite + Unpin + ?Sized, 

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

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

fn poll_flush(
    self: Pin<&mut Box<T>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut Box<T>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl<'_, T> AsyncWrite for &'_ mut T where
    T: AsyncWrite + Unpin + ?Sized, 

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

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

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

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

impl<T> AsyncWrite for Cursor<T> where
    T: Unpin + AsMut<[u8]>, 

fn poll_write(
    self: Pin<&mut Cursor<T>>,
    &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

fn poll_write_vectored(
    self: Pin<&mut Cursor<T>>,
    &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

fn poll_flush(
    self: Pin<&mut Cursor<T>>,
    &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut Cursor<T>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl AsyncWrite for Vec<u8>

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

fn poll_write_vectored(
    self: Pin<&mut Vec<u8>>,
    &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

fn poll_flush(self: Pin<&mut Vec<u8>>, &mut Context) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut Vec<u8>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Loading content...

Implementors

impl AsyncWrite for Sink

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

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

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

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

impl<A, B> AsyncWrite for Either<A, B> where
    A: AsyncWrite,
    B: AsyncWrite, 

fn poll_write(
    self: Pin<&mut Either<A, B>>,
    cx: &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

fn poll_write_vectored(
    self: Pin<&mut Either<A, B>>,
    cx: &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

fn poll_flush(
    self: Pin<&mut Either<A, B>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut Either<A, B>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl<St> AsyncWrite for IntoAsyncRead<St> where
    St: TryStream<Error = Error> + AsyncWrite + Unpin,
    <St as TryStream>::Ok: AsRef<[u8]>, 

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

fn poll_flush(
    self: Pin<&mut IntoAsyncRead<St>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut IntoAsyncRead<St>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl<T> AsyncWrite for AllowStdIo<T> where
    T: Write, 

fn poll_write(
    self: Pin<&mut AllowStdIo<T>>,
    &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

fn poll_write_vectored(
    self: Pin<&mut AllowStdIo<T>>,
    &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

fn poll_flush(
    self: Pin<&mut AllowStdIo<T>>,
    &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut AllowStdIo<T>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl<W> AsyncWrite for Compat01As03<W> where
    W: AsyncWrite, 

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

fn poll_flush(
    self: Pin<&mut Compat01As03<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut Compat01As03<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl<W> AsyncWrite for BufWriter<W> where
    W: AsyncWrite, 

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

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

fn poll_flush(
    self: Pin<&mut BufWriter<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut BufWriter<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

impl<W> AsyncWrite for WriteHalf<W> where
    W: AsyncWrite, 

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

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

fn poll_flush(
    self: Pin<&mut WriteHalf<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

fn poll_close(
    self: Pin<&mut WriteHalf<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Loading content...