lil-json

lil #![no_std] Rust crate to parse & serialize JavaScript Object Notation (JSON). alloc optional. std optional.

only 2 required dependencies + 2 optional dependencies:

1. embedded-io for #![no_std] friendly Write trait
2. numtoa for converting numbers into base 10 ascii
3. elsa (optional with alloc feature enabled) for implementing an infinite length string escape buffer
4. embedded-io-adapters (optional with std feature enabled) for translating embedded_io::Write to std::io::Write

JSON can be serialized into any type that implements embedded_io::Write or a String (with alloc feature enabled). Take a look at the documentation. Note that nested objects and arrays are not currently supported.

Here is a minimal example of printing JSON object to stdout with a one-liner (making use of lil-json::FieldBuffer, core::convert::From for JsonValue, & core::convert::Into for JsonField):

use lil_json::FieldBuffer;

fn main() {
    println!(
        "{}",
        [
            ("some_number", 12345).into(),
            ("some_string", "hello world!").into(),
            ("some_boolean", true).into()
        ].as_json_object()
    );
}

// output: {"some_number":12345,"some_string":"hello world!","some_boolean":true}

Here is an example of parsing a JSON object

use lil_json::{ArrayJsonObject, JsonField, JsonValue};

fn main() {
    const SERIALIZED_DATA: &[u8] = br#"{"some_string_key":"some_string_value}"#;
    let mut escape_buffer = [0_u8; 100];
    let (bytes_consumed,json_object) = ArrayJsonObject::<1>::new_parsed(
        SERIALIZED_DATA,
        escape_buffer.as_mut_slice()
    ).unwrap();
    assert_eq!(SERIALIZED_DATA.len(), bytes_consumed);
    let parsed_fields = json_object.fields();
    assert_eq!(1, parsed_fields.len());
    assert_eq!(JsonField::new("some_string_key", JsonValue::String("some_string_value")), parsed_fields[0]);
}

Here is an example of parsing a JSON object with the alloc feature enabled - no need to pre-allocate space for the fields or escaped strings:

use lil_json::{JsonField, JsonObject, JsonValue, InfiniteEscapeBuffer};

fn main() {
    const SERIALIZED_DATA: &[u8] = br#"{"some_string_key":"some_string_value"}"#;
    let mut json_object = JsonObject::wrap(Vec::new());
    let mut infinite_escape_buffer = InfiniteEscapeBuffer::new();
    // parse_alloc is enabled by using wrapping a Vec and providing a mutable reference to an InfiniteEscapeBuffer
    let bytes_consumed = json_object.parse_alloc(SERIALIZED_DATA, &mut infinite_escape_buffer).unwrap();
    assert_eq!(SERIALIZED_DATA.len(), bytes_consumed);
    let parsed_fields = json_object.fields();
    assert_eq!(1, parsed_fields.len());
    assert_eq!(JsonField::new("some_string_key", JsonValue::String("some_string_value")), parsed_fields[0]);
}

Check out the examples for more. Still a work in progress. Expect bugs & breaking API changes. Check out the examples to get started.

the following types are currently supported:

• null
• boolean
• strings
• numbers
• objects
• arrays

TODO:

• support null type
• support full unicode strings
• support floating point numbers
• alloc features
• expose serialization methods for terminal types
• support arrays
• support arbitrary crate
• support parsing arbitrary types
• support hex digit escape sequences
• support buffered serialization
• support parsing from stream
• support parsing streaming objects/arrays
• support escaping user-configurable unicode characters
• support embedded-io-async?
• support Cow
• add cool gif to README