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
184
185
186
187
188
189
190
191
192
193
use crate::error::DecodeError;
use futures_core::{ready, Stream};
use futures_io::AsyncRead;
use pin_project_lite::pin_project;
use std::pin::Pin;
use std::task::{Context, Poll};

const DEFAULT_BUF_SIZE: usize = 8 * 1024;

pub type Result<T> = std::result::Result<T, DecodeError>;

pin_project! {
    pub struct Utf8Decoder<R> {
        #[pin]
        reader: R,
        buf: Box<[u8]>,
        remains: usize,
    }
}

impl<R> Utf8Decoder<R> {
    pub fn new(reader: R) -> Self {
        Utf8Decoder::with_capacity(DEFAULT_BUF_SIZE, reader)
    }

    pub fn with_capacity(capacity: usize, reader: R) -> Self {
        unsafe {
            let mut buffer = Vec::with_capacity(capacity);
            buffer.set_len(capacity);
            Self {
                reader,
                buf: buffer.into_boxed_slice(),
                remains: 0,
            }
        }
    }

    pub fn into_inner(self) -> R {
        self.reader
    }

    pub fn get_ref(&self) -> &R {
        &self.reader
    }

    pub fn get_mut(&mut self) -> &mut R {
        &mut self.reader
    }
}

impl<R> Stream for Utf8Decoder<R>
where
    R: AsyncRead + Unpin,
{
    type Item = Result<String>;

    fn poll_next(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Option<<Self as Stream>::Item>> {
        let this = self.project();
        let reader = this.reader;
        let buf = this.buf;
        let (decoded, remains) = ready!(decode_next(reader, cx, buf, *this.remains))?;
        *this.remains = remains;
        if decoded.is_empty() {
            Poll::Pending
        } else {
            Poll::Ready(Some(Ok(decoded)))
        }
    }
}

fn decode_next<'a, R>(
    reader: Pin<&mut R>,
    cx: &mut Context<'_>,
    buf: &'a mut [u8],
    s: usize,
) -> Poll<Result<(String, usize)>>
where
    R: AsyncRead,
{
    debug_assert!(buf.len() > s);
    let n = ready!(reader.poll_read(cx, &mut buf[s..]))?;
    let e = s + n; //
    debug_assert!(buf.len() > e);
    let result = match std::str::from_utf8(&buf[..e]) {
        Ok(decoded) => Ok((decoded.to_string(), 0)),
        Err(err) => match err.error_len() {
            Some(_) => {
                // An unexpected byte was encounted. While this decoder is not
                // lossy decoding, return the error itself and stop decoding.
                Err(err.into())
            }
            None => {
                // The end of the input was reached unexpectedly. This is what
                // this decoder exists for.
                let (valid, after_valid) = buf.split_at(err.valid_up_to());
                // Copy 'valid' into the Heap as String
                let decoded = unsafe { std::str::from_utf8_unchecked(valid) };
                let decoded = decoded.to_string();
                // Copy 'after_valid' at the front of the 'buf'
                let remains = e - valid.len();
                unsafe {
                    // +-------------------------------------------------------------+
                    // |                            buf                              |
                    // +----------------+--------------------------------------------+
                    // |     valid      | after_valid                                |
                    // +----------------+--------------------------------------------+
                    // |////////////////|#####.......................................|
                    // +----------------+--------------------------------------------+
                    //                               |
                    //                               v
                    // +-------------------------------------------------------------+
                    // |                            buf                              |
                    // +----------------+--------------------------------------------+
                    // |     valid      | after_valid                                |
                    // +----------------+--------------------------------------------+
                    // |#####...........|............................                |
                    // +----------------+--------------------------------------------+
                    //
                    // XXX: Can we use 'copy_nonoverlapping' here?
                    // std::ptr::copy_nonoverlapping(after_valid.as_ptr(), buf.as_mut_ptr(), remains);
                    std::ptr::copy(after_valid.as_ptr(), buf.as_mut_ptr(), remains);
                }
                Ok((decoded, remains))
            }
        },
    };
    Poll::Ready(result)
}

#[cfg(test)]
mod tests {
    use super::*;
    use anyhow::Result;
    use async_std::future::timeout;
    use async_std::io::Cursor;
    use async_std::prelude::*;
    use std::time::Duration;

    #[async_std::test]
    async fn decoder_ok() -> Result<()> {
        let dur = Duration::from_millis(10);
        let cur = Cursor::new(Vec::new());
        let mut decoder = Utf8Decoder::new(cur);

        async fn append(cursor: &mut Cursor<Vec<u8>>, data: &[u8]) -> Result<()> {
            let p = cursor.position();
            cursor.set_position(cursor.get_ref().len() as u64);
            cursor.write(data).await?;
            cursor.set_position(p);
            Ok(())
        }

        // Decode full
        append(decoder.get_mut(), &vec![240, 159, 146, 150]).await?;
        let decoded = timeout(dur, decoder.next()).await?.unwrap()?;
        assert_eq!("💖", decoded);

        // Decode half
        append(decoder.get_mut(), &vec![240, 159]).await?;
        assert!(timeout(dur, decoder.next()).await.is_err());
        append(decoder.get_mut(), &vec![146, 150]).await?;
        let decoded = timeout(dur, decoder.next()).await?.unwrap()?;
        assert_eq!("💖", decoded);

        // Decode char
        append(decoder.get_mut(), &vec![240]).await?;
        assert!(timeout(dur, decoder.next()).await.is_err());
        append(decoder.get_mut(), &vec![159]).await?;
        assert!(timeout(dur, decoder.next()).await.is_err());
        append(decoder.get_mut(), &vec![146]).await?;
        assert!(timeout(dur, decoder.next()).await.is_err());
        append(decoder.get_mut(), &vec![150]).await?;
        let decoded = timeout(dur, decoder.next()).await?.unwrap()?;
        assert_eq!("💖", decoded);

        // Decode lot
        append(
            decoder.get_mut(),
            &vec![
                240, 159, 146, 150, 240, 159, 146, 150, 240, 159, 146, 150, 240, 159, 146, 150,
                240, 159, 146, 150,
            ],
        )
        .await?;
        let decoded = timeout(dur, decoder.next()).await?.unwrap()?;
        assert_eq!("💖💖💖💖💖", decoded);

        Ok(())
    }
}