Struct tokio::io::DuplexStream

pub struct DuplexStream { /* fields omitted */ }

A bidirectional pipe to read and write bytes in memory.

A pair of DuplexStreams are created together, and they act as a "channel" that can be used as in-memory IO types. Writing to one of the pairs will allow that data to be read from the other, and vice versa.

Example

let (mut client, mut server) = tokio::io::duplex(64);

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

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

server.write_all(b"pong").await?;

client.read_exact(&mut buf).await?;
assert_eq!(&buf, b"pong");

Trait Implementations

impl AsyncRead for DuplexStream

This is supported on crate feature io-util only.

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

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for DuplexStream

This is supported on crate feature io-util only.

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

Attempt to write bytes from buf into the object.

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

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

pub fn poll_shutdown(
    mut 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.

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

pub fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for DuplexStream

This is supported on crate feature io-util only.

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

Formats the value using the given formatter.

impl Drop for DuplexStream

This is supported on crate feature io-util only.

pub fn drop(&mut self)

Executes the destructor for this type.