commit	1ac1d06d6f28fc22b468ac2dd246827b2b288779	[log] [tgz]
author	Android Build Coastguard Worker <[email protected]>	Wed Dec 13 00:13:38 2023 +0000
committer	Android Build Coastguard Worker <[email protected]>	Wed Dec 13 00:13:38 2023 +0000
tree	36b7860d168f0946cbec125ce85feec1522a02b5
parent	71ed3b815dc8cc4f2db6556e97e2b418778dc585 [diff]
parent	91d0e4d229c573dcc5ebc80006f52ea6e7741485 [diff]

tree: 36b7860d168f0946cbec125ce85feec1522a02b5

README.md

tinyjson

tinyjson is a library to parse/generate JSON format document.

Goals of this library are

Simplicity: This library uses standard containers like Vec or HashMap as its internal representation and exposes it to users. Users can operate JSON values via the standard APIs. And it keeps this crate as small as possible.
Explicit: This library does not hide memory allocation from users. You need to allocate memory like Vec, String, HashMap by yourself. It is good for readers of your source code to show where memory allocations happen. And you can have control of how memory is allocated (e.g. allocating memory in advance with with_capacity method).
No dependencies: This library is built on top of only standard libraries.
No unsafe code: This library is built with Safe Rust.
Well tested: This library is tested with famous test suites:

Documentation

Requirements

Rust stable toolchain.

Installation

Add this crate to dependencies section of your Cargo.toml

[dependencies]
tinyjson = "2"

Example

use tinyjson::JsonValue;
use std::collections::HashMap;
use std::convert::TryInto;

let s = r#"
    {
        "bool": true,
        "arr": [1, null, "test"],
        "nested": {
            "blah": false,
            "blahblah": 3.14
        },
        "unicode": "\u2764"
    }
"#;

// Parse from strings
let parsed: JsonValue = s.parse().unwrap();

// Access to inner value represented with standard containers
let object: &HashMap<_, _> = parsed.get().unwrap();
println!("Parsed HashMap: {:?}", object);

// Generate JSON string
println!("{}", parsed.stringify().unwrap());
// Generate formatted JSON string with indent
println!("{}", parsed.format().unwrap());

// Convert to inner value represented with standard containers
let object: HashMap<_, _> = parsed.try_into().unwrap();
println!("Converted into HashMap: {:?}", object);

// Create JSON values from standard containers
let mut m = HashMap::new();
m.insert("foo".to_string(), true.into());
let mut v = JsonValue::from(m);

// Access with `Index` and `IndexMut` operators quickly
println!("{:?}", v["foo"]);
v["foo"] = JsonValue::from("hello".to_string());
println!("{:?}", v["foo"]);

See the document to know all APIs.

Repository

https://github.com/rhysd/tinyjson

License

the MIT License