Struct `SimplexStream`

pub struct SimplexStream { /* private fields */ }

A unidirectional pipe to read and write bytes in memory.

It can be constructed by simplex function which will create a pair of reader and writer or by calling SimplexStream::new_unsplit that will create a handle for both reading and writing.

Example

# async fn ex() -> std::io::Result<()> {
# use tokio::io::{AsyncReadExt, AsyncWriteExt};
let (mut receiver, mut sender) = tokio::io::simplex(64);

sender.write_all(b"ping").await?;

let mut buf = [0u8; 4];
receiver.read_exact(&mut buf).await?;
assert_eq!(&buf, b"ping");
# Ok(())
# }

Implementations

`impl SimplexStream`

fn new_unsplit(max_buf_size: usize) -> SimplexStream

Creates unidirectional buffer that acts like in memory pipe. To create split version with separate reader and writer you can use simplex function.

The max_buf_size argument is the maximum amount of bytes that can be written to a buffer before it returns Poll::Pending.

Trait Implementations

`impl AsyncRead for SimplexStream`

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

`impl AsyncWrite for SimplexStream`

fn poll_write(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize>>
fn poll_write_vectored(self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>]) -> Poll<Result<usize, Error>>
fn is_write_vectored(&self) -> bool
fn poll_flush(self: Pin<&mut Self>, &mut Context<'_>) -> Poll<Result<()>>
fn poll_shutdown(self: Pin<&mut Self>, &mut Context<'_>) -> Poll<Result<()>>