1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
//! Merge two separate [`AsyncRead`](futures::io::AsyncRead) and
//! [`AsyncWrite`](futures::io::AsyncWrite) objects into a single I/O stream.
//!
//! # Examples
//!
//! ```
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! # futures::executor::block_on(async {
//! use merge_io::MergeIO;
//! use futures::io::Cursor;
//! use futures::{AsyncReadExt, AsyncWriteExt};
//!
//! // Prepare `reader` to read data from...
//! let reader = Cursor::new(vec![1, 2, 3, 4]);
//!
//! // ... and `writer` to read data to.
//! let writer: Vec<u8> = vec![];
//!
//! // Merge `reader` and `writer` into a single I/O stream.
//! let mut stream = MergeIO::new(reader, writer);
//!
//! // Read data from stream.
//! let mut read_buf = Vec::<u8>::with_capacity(1024);
//! stream.read_to_end(&mut read_buf).await?;
//!
//! // We got what was in the `reader`!
//! assert_eq!(&read_buf, &[1, 2, 3, 4]);
//!
//! // Write data to stream.
//! stream.write_all(&[10, 20, 30, 40]).await?;
//!
//! // `writer` now contains what we wrote!
//! assert_eq!(stream.writer(), &[10, 20, 30, 40]);
//!
//! # Ok(())
//! # })
//! # }
//! ```

#![warn(missing_debug_implementations, rust_2018_idioms, missing_docs)]

use futures_io::{AsyncRead, AsyncWrite};
use std::io::{IoSlice, IoSliceMut, Result};
use std::pin::Pin;
use std::task::{Context, Poll};

/// Merged I/O, delegates reads and writes to the provided
/// [`AsyncRead`](futures::io::AsyncRead) (`R`) and
/// [`AsyncWrite`](futures::io::AsyncWrite) (`W`).
#[derive(Debug)]
pub struct MergeIO<R, W>
where
    R: AsyncRead + Unpin,
    W: AsyncWrite + Unpin,
{
    reader: R,
    writer: W,
}

impl<R, W> MergeIO<R, W>
where
    R: AsyncRead + Unpin,
    W: AsyncWrite + Unpin,
{
    /// Creates new [`MergeIO`](crate::MergeIO), that reads to `reader` and
    /// writes to `writer`.
    pub fn new(reader: R, writer: W) -> Self {
        MergeIO { reader, writer }
    }

    /// Provides access to `reader`.
    pub fn reader(&self) -> &R {
        &self.reader
    }

    /// Provides access to `writer`.
    pub fn writer(&self) -> &W {
        &self.writer
    }

    /// Provides `mut` access to `reader`.
    pub fn reader_mut(&mut self) -> &mut R {
        &mut self.reader
    }

    /// Provides `mut` access to `writer`.
    pub fn writer_mut(&mut self) -> &mut W {
        &mut self.writer
    }

    /// Deconstructs `MergeIO` into the `reader` and `writer`.
    pub fn into_inner(self) -> (R, W) {
        (self.reader, self.writer)
    }
}

impl<R, W> AsyncRead for MergeIO<R, W>
where
    R: AsyncRead + Unpin,
    W: AsyncWrite + Unpin,
{
    fn poll_read(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut [u8],
    ) -> Poll<Result<usize>> {
        AsyncRead::poll_read(Pin::new(&mut self.get_mut().reader), cx, buf)
    }

    fn poll_read_vectored(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        bufs: &mut [IoSliceMut<'_>],
    ) -> Poll<Result<usize>> {
        AsyncRead::poll_read_vectored(Pin::new(&mut self.get_mut().reader), cx, bufs)
    }
}

impl<R, W> AsyncWrite for MergeIO<R, W>
where
    R: AsyncRead + Unpin,
    W: AsyncWrite + Unpin,
{
    fn poll_write(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize>> {
        AsyncWrite::poll_write(Pin::new(&mut self.get_mut().writer), cx, buf)
    }

    fn poll_write_vectored(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        bufs: &[IoSlice<'_>],
    ) -> Poll<Result<usize>> {
        AsyncWrite::poll_write_vectored(Pin::new(&mut self.get_mut().writer), cx, bufs)
    }

    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
        AsyncWrite::poll_flush(Pin::new(&mut self.get_mut().writer), cx)
    }

    fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
        AsyncWrite::poll_close(Pin::new(&mut self.get_mut().writer), cx)
    }
}