#json #validate-json #validation #data-integrity #parser #serialization #data-structures

bin+lib jsonparser

A Rust crate for efficient parsing and validation of JSON data into strongly typed Rust data structures, enabling data integrity checks

12 releases

0.2.1 Feb 17, 2024
0.2.0 Feb 17, 2024
0.1.9 Feb 16, 2024

#595 in Parser implementations

Download history 160/week @ 2024-02-10 235/week @ 2024-02-17 49/week @ 2024-02-24 60/week @ 2024-03-30 12/week @ 2024-04-06

72 downloads per month

MIT/Apache

49KB
1K SLoC

JSON Parser

This Rust crate provides a robust and efficient solution for parsing JSON data into Rust's strongly-typed data structures. It's designed to simplify the process of converting JSON text into Rust types and allows you to validate your JSON data with schema-based validation, making it easier to work with JSON data in Rust applications.

Features

  • Strong Typing: Leverages Rust's type system to ensure that JSON data is parsed into the correct Rust data structures.
  • Error Handling: Provides comprehensive error handling to catch and manage parsing errors, making your application more robust.
  • Schema-Based Validation: This ensures that the JSON data adheres to a predefined schema, reducing runtime errors, enhancing data integrity and allows you to transform JSON values before validation.

Getting Started

To use this crate in your project, add it to your Cargo.toml:

[dependencies]
jsonparser = "0.2.1"

Then, import it in your Rust file:

use jsonparser::*;

Basic Usage

Parsing JSON to Rust

To parse a JSON string into a Rust JSONValue, use the from function provided by the crate:

use jsonparser::JSONParser;

let input = r#"
    {
        "name": "John Doe",
        "age": 30,
        "is_student": false
    }
"#;

match JSONParser::from(input) {
    Ok(json) => println!("{:#?}", json),
    Err(e) => eprintln!("Failed to parse JSON: {}", e),
}

Accessing Data

Once parsed, access the data using the .get() method or the indexing syntax for both objects and arrays:

// Using `.get()` method
if let Some(name) = json.get("name").and_then(|v| v.as_str()) {
    println!("Name: {}", name);
}

// Using indexing syntax
let age = &json["age"];
if let Some(age) = age.as_f64() {
    println!("Age: {}", age);
}

Serialization

To serialize a Rust data structure into a JSON string, use the serialize method:

use jsonparser::{JSONParser, JSONValue};

let json: JSONValue = JSONParser::from(r#"{ "name": "John Doe", "age": 30, "is_student": false }"#).unwrap();
let serialized = json.serialize();

assert_eq!(serialized, r#"{"name":"John Doe","age":30,"is_student":false}"#);

Validation

To validate a JSONValue, use the validate method:

use jsonparser::{JSONParser, JSONValue, JSONSchema, StringType, NumberType, BooleanType};

let json: JSONValue = JSONParser::from(r#"{ "name": "John Doe", "age": 30, "is_student": false }"#).unwrap();
let schema = JSONSchema::new([
    ("name", StringType::new().min_length(3).trim().boxed()),
    ("age", NumberType::new().gt(18).lt(100).boxed()),
    ("is_student", BooleanType::new().falsy().boxed()),
]);

assert!(schema.validate(&json).is_ok());

Contribution

Contributions are welcome! If you have suggestions for improvements or find any issues, please open an issue or submit a pull request on GitHub.

License

This project is licensed under the Apache-2.0 license.

No runtime deps