async-utf8-decoder 0.1.1

Convert AsyncRead to incremental UTF8 string stream
Documentation 
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

[![crates.io](https://img.shields.io/crates/v/async-utf8-decoder.svg)](https://crates.io/crates/async-utf8-decoder)
[![docs.rs](https://docs.rs/async-utf8-decoder/badge.svg)](https://docs.rs/async-utf8-decoder)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![Build](https://github.com/lambdalisue/rs-async-utf8-decoder/actions/workflows/build.yml/badge.svg)](https://github.com/lambdalisue/rs-async-utf8-decoder/actions/workflows/build.yml)
[![Test](https://github.com/lambdalisue/rs-async-utf8-decoder/actions/workflows/test.yml/badge.svg)](https://github.com/lambdalisue/rs-async-utf8-decoder/actions/workflows/test.yml)
[![Audit](https://github.com/lambdalisue/rs-async-utf8-decoder/actions/workflows/audit.yml/badge.svg)](https://github.com/lambdalisue/rs-async-utf8-decoder/actions/workflows/audit.yml)

# async-utf8-decoder

Incremental UTF8 decoder which convert [`AsyncRead`][] into [`Stream`][] of [futures-rs][].

[`AsyncRead`]: https://docs.rs/futures/0.3.13/futures/prelude/trait.AsyncRead.html 
[`Stream`]: https://docs.rs/futures/0.3.13/futures/stream/trait.Stream.html
[futures-rs]: https://docs.rs/futures/0.3.13/futures/index.html 

## Example

```rust
use anyhow::Result;
use async_std::io::Cursor;
use async_std::future::timeout;
use async_std::prelude::*;
use std::time::Duration;
use async_utf8_decoder::Utf8Decoder;

async fn test() -> 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(())
}
```

## License

The code follows MIT license written in [LICENSE](./LICENSE). Contributors need
to agree that any modifications sent in this repository follow the license.