tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-08-24 00:00:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

codec: Remove Unpin requirement from Framed[Read,Write,] (#1758)

Browse Source 
cc #1252
This commit is contained in:
Markus Westerlind
2019-11-15 16:30:07 +09:00
committed by Taiki Endo
parent 27e5b41067
commit 930679587a
6 changed files with 219 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio-util/src/codec/framed_read.rs
+81 -30
View File
@@ -1,4 +1,4 @@
use crate::codec::framed::Fuse;
use crate::codec::framed::{Fuse, ProjectFuse};
use crate::codec::Decoder;
use tokio::io::AsyncRead;
@@ -7,16 +7,21 @@ use bytes::BytesMut;
use futures_core::Stream;
use futures_sink::Sink;
use log::trace;
use pin_project::pin_project;
use std::fmt;
use std::pin::Pin;
use std::task::{Context, Poll};
/// A `Stream` of messages decoded from an `AsyncRead`.
#[pin_project]
pub struct FramedRead<T, D> {
#[pin]
inner: FramedRead2<Fuse<T, D>>,
}
#[pin_project]
pub(crate) struct FramedRead2<T> {
#[pin]
inner: T,
eof: bool,
is_readable: bool,
@@ -35,7 +40,10 @@ where
/// Creates a new `FramedRead` with the given `decoder`.
pub fn new(inner: T, decoder: D) -> FramedRead<T, D> {
FramedRead {
inner: framed_read2(Fuse(inner, decoder)),
inner: framed_read2(Fuse {
io: inner,
codec: decoder,
}),
}
}
}
@@ -48,7 +56,7 @@ impl<T, D> FramedRead<T, D> {
/// 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
&self.inner.inner.io
}
/// Returns a mutable reference to the underlying I/O stream wrapped by
@@ -58,7 +66,7 @@ impl<T, D> FramedRead<T, D> {
/// 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
&mut self.inner.inner.io
}
/// Consumes the `FramedRead`, returning its underlying I/O stream.
@@ -67,17 +75,17 @@ impl<T, D> FramedRead<T, D> {
/// 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
self.inner.inner.io
}
/// Returns a reference to the underlying decoder.
pub fn decoder(&self) -> &D {
&self.inner.inner.1
&self.inner.inner.codec
}
/// Returns a mutable reference to the underlying decoder.
pub fn decoder_mut(&mut self) -> &mut D {
&mut self.inner.inner.1
&mut self.inner.inner.codec
}
/// Returns a reference to the read buffer.
@@ -88,38 +96,61 @@ impl<T, D> FramedRead<T, D> {
impl<T, D> Stream for FramedRead<T, D>
where
T: AsyncRead + Unpin,
D: Decoder + Unpin,
T: AsyncRead,
D: Decoder,
{
type Item = Result<D::Item, D::Error>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
pin!(self.get_mut().inner).poll_next(cx)
self.project().inner.poll_next(cx)
}
}
// This impl just defers to the underlying T: Sink
impl<T, I, D> Sink<I> for FramedRead<T, D>
where
T: Sink<I> + Unpin,
D: Unpin,
T: Sink<I>,
{
type Error = T::Error;
fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
pin!(Pin::get_mut(self).inner.inner.0).poll_ready(cx)
self.project()
.inner
.project()
.inner
.project()
.io
.poll_ready(cx)
}
fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error> {
pin!(Pin::get_mut(self).inner.inner.0).start_send(item)
self.project()
.inner
.project()
.inner
.project()
.io
.start_send(item)
}
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
pin!(Pin::get_mut(self).inner.inner.0).poll_flush(cx)
self.project()
.inner
.project()
.inner
.project()
.io
.poll_flush(cx)
}
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
pin!(Pin::get_mut(self).inner.inner.0).poll_close(cx)
self.project()
.inner
.project()
.inner
.project()
.io
.poll_close(cx)
}
}
@@ -130,8 +161,8 @@ where
{
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("inner", &self.inner.inner.io)
.field("decoder", &self.inner.inner.codec)
.field("eof", &self.inner.eof)
.field("is_readable", &self.inner.is_readable)
.field("buffer", &self.inner.buffer)
@@ -180,6 +211,10 @@ impl<T> FramedRead2<T> {
&mut self.inner
}
pub(crate) fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T> {
self.project().inner
}
pub(crate) fn buffer(&self) -> &BytesMut {
&self.buffer
}
@@ -187,49 +222,65 @@ impl<T> FramedRead2<T> {
impl<T> Stream for FramedRead2<T>
where
T: AsyncRead + Decoder + Unpin,
T: ProjectFuse + AsyncRead,
T::Codec: Decoder,
{
type Item = Result<T::Item, T::Error>;
type Item = Result<<T::Codec as Decoder>::Item, <T::Codec as Decoder>::Error>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let pinned = Pin::get_mut(self);
let mut pinned = self.project();
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 pinned.is_readable {
if pinned.eof {
let frame = pinned.inner.decode_eof(&mut pinned.buffer)?;
if *pinned.is_readable {
if *pinned.eof {
let frame = pinned
.inner
.as_mut()
.project()
.codec
.decode_eof(&mut pinned.buffer)?;
return Poll::Ready(frame.map(Ok));
}
trace!("attempting to decode a frame");
if let Some(frame) = pinned.inner.decode(&mut pinned.buffer)? {
if let Some(frame) = pinned
.inner
.as_mut()
.project()
.codec
.decode(&mut pinned.buffer)?
{
trace!("frame decoded from buffer");
return Poll::Ready(Some(Ok(frame)));
}
pinned.is_readable = false;
*pinned.is_readable = false;
}
assert!(!pinned.eof);
assert!(!*pinned.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
pinned.buffer.reserve(1);
let bytect = match pin!(pinned.inner).poll_read_buf(cx, &mut pinned.buffer)? {
let bytect = match pinned
.inner
.as_mut()
.poll_read_buf(cx, &mut pinned.buffer)?
{
Poll::Ready(ct) => ct,
Poll::Pending => return Poll::Pending,
};
if bytect == 0 {
pinned.eof = true;
*pinned.eof = true;
}
pinned.is_readable = true;
*pinned.is_readable = true;
}
}
}