#serde-json #json #serde #framing

no-std json-lines

A no_std + serde compatible message library implementing JSON Lines

2 releases

0.1.1 Nov 21, 2023
0.1.0 Nov 20, 2023

#856 in Encoding

Download history 3/week @ 2024-03-13 6/week @ 2024-03-20 94/week @ 2024-03-27 211/week @ 2024-04-03 301/week @ 2024-04-10 358/week @ 2024-04-17 112/week @ 2024-04-24 124/week @ 2024-05-01 90/week @ 2024-05-08 94/week @ 2024-05-15 76/week @ 2024-05-22 227/week @ 2024-05-29 78/week @ 2024-06-05 196/week @ 2024-06-12 102/week @ 2024-06-19 82/week @ 2024-06-26

469 downloads per month

MIT/Apache

16KB
221 lines

json-lines

Crates.io Documentation Crate License Dependency status build

json-lines is a #![no_std] + serde compatible message library implementing the JSON Lines format.

High-level overview

The crate provides a Rust-language implementation of JSON Lines (JSONL), also known as Newline-Delimited JSON (NDJSON).

The wikipedia page JSON Streaming and jsonlines.org are good resources describing the format.

This crate endeavors to have a similar API to the postcard crate. This way, Rust code can easily switch between JSONL and postcard formats depending on requirements. JSONL is "self-describing" but less efficient, whereas postcard is very compact but requires an out-of-band knowledge of message structure.

The crate contains a #![no_std] implementation for use in, e.g. embedded contexts. The std feature is enabled by defaults and provides things such as the [Error] enum implements the std::error::Error Trait.

The codec feature enables crate::codec::JsonLinesCodec, which provides an implementation of tokio_util::codec::Decoder and tokio_util::codec::Encoder.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~1–3MB
~59K SLoC