Struct JoinReadWrite

pub struct JoinReadWrite<R: AsyncRead, W: AsyncWrite> { /* private fields */ }

Async readable/writeable that dispatches reads to R and writes to W

AsyncRead is forwarded to R. AsyncWrite is forwarded to W.

JoinReadWrite::new() is the converse of AsyncReadExt::split(). But, if R and W came from splitting a single AsyncRead + AsyncWrite, you probably want the reunite or unsplit method, instead of JoinReadWrite.

Does not implement any kind of flushing behaviour when switching between reading and writing.

Example

use tor_async_utils::JoinReadWrite;
use futures::{AsyncReadExt as _, AsyncWriteExt as _};

let read = b"hello\n";
let mut read = &read[..];
let mut write = Vec::<u8>::new();

let mut joined = JoinReadWrite::new(read, write);

let mut got = String::new();
let _: usize = joined.read_to_string(&mut got).await.unwrap();
assert_eq!(got, "hello\n");

let () = joined.write_all(b"some data").await.unwrap();

let (r, w) = joined.into_parts();
assert_eq!(w, b"some data");

Implementations

impl<R: AsyncRead, W: AsyncWrite> JoinReadWrite<R, W>

pub fn new(r: R, w: W) -> Self

Join an AsyncRead and an AsyncWrite into a single impl AsyncRead + AsyncWrite

pub fn into_parts(self) -> (R, W)

Dismantle a JoinReadWrite into its constituent AsyncRead and AsyncWrite

Trait Implementations

impl<R: AsyncRead, W: AsyncWrite> AsyncRead for JoinReadWrite<R, W>

fn poll_read( self: Pin<&mut Self>, c: &mut Context<'_>, out: &mut [u8], ) -> Poll<Result<usize, Error>>

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

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

impl<R: AsyncRead, W: AsyncWrite> AsyncWrite for JoinReadWrite<R, W>

fn poll_write( self: Pin<&mut Self>, c: &mut Context<'_>, data: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

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

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

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

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<'pin, R: AsyncRead, W: AsyncWrite> Unpin for JoinReadWrite<R, W>

where PinnedFieldsOf<__JoinReadWrite<'pin, R, W>>: Unpin,