Struct partial_io::PartialAsyncWrite

pub struct PartialAsyncWrite<W> { /* private fields */ }

Available on crate feature futures03 only.

A wrapper that breaks inner AsyncWrite instances up according to the provided iterator.

Available with the futures03 feature for futures traits, and with the tokio1 feature for tokio traits.

Examples

This example uses tokio.

use partial_io::{PartialAsyncWrite, PartialOp};
use std::io::{self, Cursor};
use tokio::io::AsyncWriteExt;

#[tokio::main]
async fn main() -> io::Result<()> {
    let writer = Cursor::new(Vec::new());
    // Sequential calls to `poll_write()` and the other `poll_` methods simulate the following behavior:
    let iter = vec![
        PartialOp::Err(io::ErrorKind::WouldBlock),   // A not-ready state.
        PartialOp::Limited(2),                       // Only allow 2 bytes to be written.
        PartialOp::Err(io::ErrorKind::InvalidData),  // Error from the underlying stream.
        PartialOp::Unlimited,                        // Allow as many bytes to be written as possible.
    ];
    let mut partial_writer = PartialAsyncWrite::new(writer, iter);
    let in_data = vec![1, 2, 3, 4];

    // This causes poll_write to be called twice, yielding after the first call (WouldBlock).
    assert_eq!(partial_writer.write(&in_data).await?, 2);
    let cursor_ref = partial_writer.get_ref();
    let out = cursor_ref.get_ref();
    assert_eq!(&out[..], &[1, 2]);

    // This next call returns an error.
    assert_eq!(
        partial_writer.write(&in_data[2..]).await.unwrap_err().kind(),
        io::ErrorKind::InvalidData,
    );

    // And this one causes the last two bytes to be written.
    assert_eq!(partial_writer.write(&in_data[2..]).await?, 2);
    let cursor_ref = partial_writer.get_ref();
    let out = cursor_ref.get_ref();
    assert_eq!(&out[..], &[1, 2, 3, 4]);

    Ok(())
}

Implementations

impl<W> PartialAsyncWrite<W>

pub fn new<I>(inner: W, iter: I) -> Selfwhere
    I: IntoIterator<Item = PartialOp> + 'static,
    I::IntoIter: Send,

Creates a new PartialAsyncWrite wrapper over the writer with the specified PartialOps.

pub fn set_ops<I>(&mut self, iter: I) -> &mut Selfwhere
    I: IntoIterator<Item = PartialOp> + 'static,
    I::IntoIter: Send,

Sets the PartialOps for this writer.

pub fn pin_set_ops<I>(self: Pin<&mut Self>, iter: I) -> Pin<&mut Self>where
    I: IntoIterator<Item = PartialOp> + 'static,
    I::IntoIter: Send,

Sets the PartialOps for this writer in a pinned context.

pub fn get_ref(&self) -> &W

Returns a shared reference to the underlying writer.

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

Returns a mutable reference to the underlying writer.

pub fn pin_get_mut(self: Pin<&mut Self>) -> Pin<&mut W>

Returns a pinned mutable reference to the underlying writer.

pub fn into_inner(self) -> W

Consumes this wrapper, returning the underlying writer.

Trait Implementations

impl<W> AsyncBufRead for PartialAsyncWrite<W>where
    W: AsyncBufRead,

This is a forwarding impl to support duplex structs.

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

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<W> AsyncBufRead for PartialAsyncWrite<W>where
    W: AsyncBufRead,

Available on crate feature tokio1 only.

This is a forwarding impl to support duplex structs.

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

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<W> AsyncRead for PartialAsyncWrite<W>where
    W: AsyncRead,

This is a forwarding impl to support duplex structs.

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>>

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

impl<W> AsyncRead for PartialAsyncWrite<W>where
    W: AsyncRead,

Available on crate feature tokio1 only.

This is a forwarding impl to support duplex structs.

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

Attempts to read from the AsyncRead into buf.

impl<W> AsyncSeek for PartialAsyncWrite<W>where
    W: AsyncSeek,

This is a forwarding impl to support duplex structs.

fn poll_seek(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    pos: SeekFrom
) -> Poll<Result<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl<W> AsyncSeek for PartialAsyncWrite<W>where
    W: AsyncSeek,

Available on crate feature tokio1 only.

This is a forwarding impl to support duplex structs.

fn start_seek(self: Pin<&mut Self>, position: SeekFrom) -> Result<()>

Attempts to seek to an offset, in bytes, in a stream.

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

Waits for a seek operation to complete.

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

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_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.

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<W> AsyncWrite for PartialAsyncWrite<W>where
    W: AsyncWrite,

Available on crate feature tokio1 only.

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_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

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

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

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<W> Debug for PartialAsyncWrite<W>where
    W: Debug,

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

Formats the value using the given formatter.

impl<'pin, W> Unpin for PartialAsyncWrite<W>where
    __PartialAsyncWrite<'pin, W>: Unpin,