asyncjsonstream 0.1.0

Async JSON stream reader for selective parsing of large payloads
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
82
83

# asyncjsonstream

Async JSON stream reader for selective parsing of large payloads. This is the
standalone home of Extract's `AsyncJsonStreamReader` implementation.

[![crates.io](https://img.shields.io/crates/v/asyncjsonstream.svg)](https://crates.io/crates/asyncjsonstream)
[![docs.rs](https://docs.rs/asyncjsonstream/badge.svg)](https://docs.rs/asyncjsonstream)
[![license](https://img.shields.io/crates/l/asyncjsonstream.svg)](LICENSE-MIT)
[![ci](https://github.com/singular-labs/async-json-streamer/actions/workflows/ci.yml/badge.svg)](https://github.com/singular-labs/async-json-streamer/actions/workflows/ci.yml)

## Why asyncjsonstream

- Stream through large JSON without deserializing the full payload.
- Selectively read keys, values, and arrays using a tokenized reader.
- Handles chunk boundaries and escaped strings correctly.
- Built on Tokio `AsyncRead`.
- No unsafe code.

## Install

```bash
cargo add asyncjsonstream
```

## Quick start

```rust
use asyncjsonstream::AsyncJsonStreamReader;
use std::io::Cursor;

#[tokio::main]
async fn main() -> Result<(), asyncjsonstream::AsyncJsonStreamReaderError> {
    let data = r#"{"status":"success","results":[{"id":1},{"id":2}]}"#;
    let mut reader = AsyncJsonStreamReader::new(Cursor::new(data.as_bytes().to_vec()));

    while let Some(key) = reader.next_object_entry().await? {
        match key.as_str() {
            "status" => {
                let status = reader.read_string().await?;
                println!("status={status}");
            }
            "results" => {
                while reader.start_array_item().await? {
                    let obj = reader.deserialize_object().await?;
                    println!("id={}", obj["id"]);
                }
            }
            _ => {}
        }
    }

    Ok(())
}
```

## Common patterns

- Read object entries with `next_object_entry`.
- Skip values by calling `next_object_entry` again without consuming the value.
- Stream arrays with `start_array_item`.
- Parse string/number/bool with `read_string`, `read_number`, `read_boolean`.
- Deserialize a sub-object with `deserialize_object`.

## Error handling

All fallible operations return `AsyncJsonStreamReaderError`:

- `Io` for reader failures
- `JsonError` for malformed JSON
- `UnexpectedToken` when the stream doesn't match the expected structure

## MSRV

Minimum supported Rust version is **1.74**.

## License

Licensed under either of:

- Apache License, Version 2.0 (`LICENSE-APACHE`)
- MIT license (`LICENSE-MIT`)

at your option.