#json #no-std

no-std microjson

No frills JSON parsing without allocations

3 releases

0.1.2 Jul 4, 2022
0.1.1 Oct 30, 2021
0.1.0 Oct 24, 2021

#332 in Rust patterns

Download history 27/week @ 2022-08-09 14/week @ 2022-08-16 17/week @ 2022-08-23 10/week @ 2022-08-30 22/week @ 2022-09-06 19/week @ 2022-09-13 19/week @ 2022-09-20 30/week @ 2022-09-27 33/week @ 2022-10-04 12/week @ 2022-10-11 6/week @ 2022-10-18 28/week @ 2022-10-25 26/week @ 2022-11-01 25/week @ 2022-11-08 28/week @ 2022-11-15 28/week @ 2022-11-22

112 downloads per month
Used in 4 crates (via acrylic)

GPL-3.0-only

4MB
676 lines

Small JSON Parser in no_std

Build Status Latest Version Coverage Status Docs

This library reads and parses JSON strings.

Its intended use case is to read a JSON payload once.

It does not serialise data.

Sample usage

Simply put this in your Cargo.toml:

[dependencies]
microjson = "0.1"

You can read strings and integers easily:

# use microjson::{JSONValue, JSONParsingError};
# fn main() -> Result<(), JSONParsingError> {
let integer = JSONValue::parse("42")?;

let value : isize = integer.read_integer()?;

let string = JSONValue::parse("\"hello there\"")?;

let value : &str = string.read_string()?;
# Ok(())
# }

You can read arrays like this:

# use microjson::{JSONValue, JSONParsingError};
# fn main() -> Result<(), JSONParsingError> {
let input = r#" [0, 1, 2, 3, 4, 5] "#;

let array = JSONValue::parse(input)?;

for (n, item) in array.iter_array()?.enumerate() {
    let value = item.read_integer()?;
    assert_eq!(value, n as isize);
}
# Ok(())
# }

And, of course, any combination of the above:

# use microjson::{JSONValue, JSONParsingError};
# fn main() -> Result<(), JSONParsingError> {
let input = r#" { "arr": [3, "foo", 3.625, false] } "#;

let object = JSONValue::parse(input)?;

assert_eq!(
    object.get_key_value("arr")?.iter_array()?.nth(2).unwrap().read_float()?,
    3.625
);
# Ok(())
# }

If you are unsure what kind of data you have, you can query the [JSONValueType].

# use microjson::{JSONValue, JSONValueType, JSONParsingError};
# fn main() -> Result<(), JSONParsingError> {
let input = r#" 3.1415 "#;

let object = JSONValue::parse(input)?;

match object.value_type {
    JSONValueType::String => {},
    JSONValueType::Number => {},
    JSONValueType::Object => {},
    JSONValueType::Array => {},
    JSONValueType::Bool => {},
    JSONValueType::Null => {},
}
# Ok(())
# }

Verifying Data

To load some JSON, you need only call

# use microjson::JSONValue;
let value = JSONValue::parse(r#" [1,2,3,5"foo"] "#);

However, this data is malformed. [JSONValue::parse] will return an Ok result, as to determine that the data was corrupt would require scanning through the entire string. The error would only be reported when you attempted to iterate to the fourth item and parse it as a value.

If you need to know that the data is sound, use [JSONValue::verify]. Alternatively, you can parse and verify in one step.

# use microjson::JSONValue;
let value = JSONValue::parse_and_verify(r#" [1,2,3,5"foo"] "#);

Features

  • All JSON types
  • Strings with escape sequences
  • Parse ints (using built in parser)
  • Parse floats (using built in parser)
  • Iterators over arrays
  • Object key lookup
  • Iterators over objects
  • Verify JSON

No runtime deps