use std::fmt; use std::pin::Pin; use std::task::{Context, Poll}; use bytes::BytesMut; use futures::{Sink, Stream}; use log::trace; use tokio_codec::Decoder; use tokio_io::AsyncRead; use super::framed::Fuse; /// A `Stream` of messages decoded from an `AsyncRead`. pub struct FramedRead { inner: FramedRead2>, } pub struct FramedRead2 { inner: T, eof: bool, is_readable: bool, buffer: BytesMut, } const INITIAL_CAPACITY: usize = 8 * 1024; // ===== impl FramedRead ===== impl FramedRead where T: AsyncRead, D: Decoder, { /// Creates a new `FramedRead` with the given `decoder`. pub fn new(inner: T, decoder: D) -> FramedRead { FramedRead { inner: framed_read2(Fuse(inner, decoder)), } } } impl FramedRead { /// Returns a reference to the underlying I/O stream wrapped by /// `FramedRead`. /// /// Note that care should be taken to not tamper with the underlying stream /// of data coming in as it may corrupt the stream of frames otherwise /// being worked with. pub fn get_ref(&self) -> &T { &self.inner.inner.0 } /// Returns a mutable reference to the underlying I/O stream wrapped by /// `FramedRead`. /// /// Note that care should be taken to not tamper with the underlying stream /// of data coming in as it may corrupt the stream of frames otherwise /// being worked with. pub fn get_mut(&mut self) -> &mut T { &mut self.inner.inner.0 } /// Consumes the `FramedRead`, returning its underlying I/O stream. /// /// Note that care should be taken to not tamper with the underlying stream /// of data coming in as it may corrupt the stream of frames otherwise /// being worked with. pub fn into_inner(self) -> T { self.inner.inner.0 } /// Returns a reference to the underlying decoder. pub fn decoder(&self) -> &D { &self.inner.inner.1 } /// Returns a mutable reference to the underlying decoder. pub fn decoder_mut(&mut self) -> &mut D { &mut self.inner.inner.1 } } impl Stream for FramedRead where T: AsyncRead, D: Decoder, { type Item = Result; fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { unsafe { self.map_unchecked_mut(|s| &mut s.inner).poll_next(cx) } } } impl Sink for FramedRead where T: Sink, { type Error = T::Error; fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { unsafe { self.map_unchecked_mut(|s| &mut s.inner.inner.0) .poll_ready(cx) } } fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error> { unsafe { self.map_unchecked_mut(|s| &mut s.inner.inner.0) .start_send(item) } } fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { unsafe { self.map_unchecked_mut(|s| &mut s.inner.inner.0) .poll_flush(cx) } } fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { unsafe { self.map_unchecked_mut(|s| &mut s.inner.inner.0) .poll_close(cx) } } } impl fmt::Debug for FramedRead where T: fmt::Debug, D: fmt::Debug, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_struct("FramedRead") .field("inner", &self.inner.inner.0) .field("decoder", &self.inner.inner.1) .field("eof", &self.inner.eof) .field("is_readable", &self.inner.is_readable) .field("buffer", &self.inner.buffer) .finish() } } // ===== impl FramedRead2 ===== pub fn framed_read2(inner: T) -> FramedRead2 { FramedRead2 { inner, eof: false, is_readable: false, buffer: BytesMut::with_capacity(INITIAL_CAPACITY), } } pub fn framed_read2_with_buffer(inner: T, mut buf: BytesMut) -> FramedRead2 { if buf.capacity() < INITIAL_CAPACITY { let bytes_to_reserve = INITIAL_CAPACITY - buf.capacity(); buf.reserve(bytes_to_reserve); } FramedRead2 { inner, eof: false, is_readable: !buf.is_empty(), buffer: buf, } } impl FramedRead2 { pub fn get_ref(&self) -> &T { &self.inner } pub fn into_inner(self) -> T { self.inner } pub fn into_parts(self) -> (T, BytesMut) { (self.inner, self.buffer) } pub fn get_mut(&mut self) -> &mut T { &mut self.inner } } impl Stream for FramedRead2 where T: tokio_io::AsyncRead + Decoder, { type Item = Result; fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { let mut this = unsafe { self.get_unchecked_mut() }; loop { // Repeatedly call `decode` or `decode_eof` as long as it is // "readable". Readable is defined as not having returned `None`. If // the upstream has returned EOF, and the decoder is no longer // readable, it can be assumed that the decoder will never become // readable again, at which point the stream is terminated. if this.is_readable { if this.eof { match this.inner.decode_eof(&mut this.buffer) { Ok(Some(frame)) => return Poll::Ready(Some(Ok(frame))), Ok(None) => return Poll::Ready(None), Err(e) => return Poll::Ready(Some(Err(e))), } } trace!("attempting to decode a frame"); match this.inner.decode(&mut this.buffer) { Ok(Some(frame)) => { trace!("frame decoded from buffer"); return Poll::Ready(Some(Ok(frame))); } Err(e) => return Poll::Ready(Some(Err(e))), _ => { // Need more data } } this.is_readable = false; } assert!(!this.eof); // Otherwise, try to read more data and try again. Make sure we've // got room for at least one byte to read to ensure that we don't // get a spurious 0 that looks like EOF this.buffer.reserve(1); unsafe { match Pin::new_unchecked(&mut this.inner).poll_read(cx, &mut this.buffer) { Poll::Pending => return Poll::Pending, Poll::Ready(Err(e)) => return Poll::Ready(Some(Err(e.into()))), Poll::Ready(Ok(0)) => { this.eof = true; } Poll::Ready(Ok(_cnt)) => {} } } this.is_readable = true; } } }