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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
use byteorder::{ByteOrder, NetworkEndian};
use std::{
    io,
    marker::PhantomData,
    pin::Pin,
    task::{Context, Poll},
};

use bytes::{Buf, BytesMut};
use futures_core::{ready, Stream};
use prost::Message;
use tokio::io::{AsyncRead, ReadBuf};

use crate::{AsyncDestination, AsyncFrameDestination, Framed};

const BUFFER_SIZE: usize = 8192;
const LEN_SIZE: usize = 4;

enum FillResult {
    Filled,
    Eof,
}

/// A wrapper around an async reader that produces an asynchronous stream of prost-decoded values
#[derive(Debug)]
pub struct AsyncProstReader<R, T, D> {
    reader: R,
    pub(crate) buffer: BytesMut,
    into: PhantomData<T>,
    dest: PhantomData<D>,
}
impl<R, T, D> Unpin for AsyncProstReader<R, T, D> where R: Unpin {}

impl<R, T, D> AsyncProstReader<R, T, D> {
    /// create a new reader
    pub fn new(reader: R) -> Self {
        Self {
            reader,
            buffer: BytesMut::with_capacity(BUFFER_SIZE),
            into: PhantomData,
            dest: PhantomData,
        }
    }

    /// gets a reference to the underlying reader
    pub fn get_ref(&self) -> &R {
        &self.reader
    }

    /// gets a mutable reference to the underlying reader
    pub fn get_mut(&mut self) -> &mut R {
        &mut self.reader
    }

    /// returns a reference to the internally buffered data
    pub fn buffer(&self) -> &[u8] {
        &self.buffer[..]
    }

    /// unwrap the `AsyncProstReader`, returning the underlying reader
    pub fn into_inner(self) -> R {
        self.reader
    }
}

impl<R, T, D> Default for AsyncProstReader<R, T, D>
where
    R: Default,
{
    fn default() -> Self {
        Self::from(R::default())
    }
}

impl<R, T, D> From<R> for AsyncProstReader<R, T, D> {
    fn from(reader: R) -> Self {
        Self::new(reader)
    }
}

impl<R, T> Stream for AsyncProstReader<R, T, AsyncDestination>
where
    T: Message + Default,
    R: AsyncRead + Unpin,
{
    type Item = Result<T, io::Error>;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        // FIXME: what 5 means here?
        if let FillResult::Eof = ready!(self.as_mut().fill(cx, 5))? {
            return Poll::Ready(None);
        }

        let message_size = NetworkEndian::read_u32(&self.buffer[..LEN_SIZE]) as usize;

        // since self.buffer.len() >= 4, we know that we can't get a clean EOF here
        ready!(self.as_mut().fill(cx, message_size + LEN_SIZE))?;

        self.buffer.advance(LEN_SIZE);
        let message =
            Message::decode(&self.buffer[..message_size]).map_err(prost::DecodeError::from)?;
        self.buffer.advance(message_size);
        Poll::Ready(Some(Ok(message)))
    }
}

impl<R, T> Stream for AsyncProstReader<R, T, AsyncFrameDestination>
where
    R: AsyncRead + Unpin,
    T: Framed + Default,
{
    type Item = Result<T, io::Error>;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        // FIXME: what 5 means here?
        if let FillResult::Eof = ready!(self.as_mut().fill(cx, LEN_SIZE + 1))? {
            return Poll::Ready(None);
        }

        let size = NetworkEndian::read_u32(&self.buffer[..LEN_SIZE]) as usize;
        let header_size = size >> 24;
        let body_size = 0x00ffffff & size;
        let message_size = header_size + body_size;

        // since self.buffer.len() >= 4, we know that we can't get a clean EOF here
        ready!(self.as_mut().fill(cx, message_size + LEN_SIZE))?;

        self.buffer.advance(LEN_SIZE);
        let message = T::decode(&self.buffer[..message_size], header_size)?;

        self.buffer.advance(message_size);
        Poll::Ready(Some(Ok(message)))
    }
}

impl<R, T, D> AsyncProstReader<R, T, D>
where
    R: AsyncRead + Unpin,
{
    fn fill(
        mut self: Pin<&mut Self>,
        cx: &mut Context,
        target_buffer_size: usize,
    ) -> Poll<Result<FillResult, io::Error>> {
        if self.buffer.len() >= target_buffer_size {
            // we already ave the bytes we need!
            return Poll::Ready(Ok(FillResult::Filled));
        }

        // make sure we can fit all the data we're about to read
        if self.buffer.capacity() < target_buffer_size {
            let missing = target_buffer_size - self.buffer.capacity();
            self.buffer.reserve(missing);
        }

        let had = self.buffer.len();
        // this is the bit we'll be reading into
        let mut rest = self.buffer.split_off(had);
        // this is safe because we're not extending beyond the reserved capacity
        // and we're never reading unwritten bytes
        let max = rest.capacity();
        unsafe { rest.set_len(max) };

        while self.buffer.len() < target_buffer_size {
            let mut buf = ReadBuf::new(&mut rest[..]);
            ready!(Pin::new(&mut self.reader).poll_read(cx, &mut buf))?;
            let n = buf.filled().len();
            if n == 0 {
                if self.buffer.is_empty() {
                    return Poll::Ready(Ok(FillResult::Eof));
                } else {
                    return Poll::Ready(Err(io::Error::from(io::ErrorKind::BrokenPipe)));
                }
            }

            // adopt the new bytes
            let read = rest.split_to(n);
            self.buffer.unsplit(read);
        }

        Poll::Ready(Ok(FillResult::Filled))
    }
}