Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/puripuri2100/yojson-rs
yojson parser for Rust
https://github.com/puripuri2100/yojson-rs
cargo crates json json-parser ocaml rust yojson
Last synced: about 1 month ago
JSON representation
yojson parser for Rust
- Host: GitHub
- URL: https://github.com/puripuri2100/yojson-rs
- Owner: puripuri2100
- License: mit
- Created: 2021-01-20T12:42:13.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-22T16:48:58.000Z (over 3 years ago)
- Last Synced: 2024-09-30T10:41:09.294Z (about 1 month ago)
- Topics: cargo, crates, json, json-parser, ocaml, rust, yojson
- Language: Rust
- Homepage:
- Size: 30.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yojson-rs: JSON library for Rust
[![crates.io][crates-badge]][crates]
[![docs.rs][docs-badge]][docs]
[![Build Status][ci-badge]][ci]
[![source badge][source-badge]][source]
[![license badge][license-badge]][license]
[crates]: https://crates.io/crates/yojson-rs
[crates-badge]: https://img.shields.io/crates/v/yojson-rs
[docs]: https://docs.rs/yojson-rs/
[docs-badge]: https://img.shields.io/badge/docs.rs-yojson_rs-blue
[ci]: https://github.com/puripuri2100/yojson-rs/actions?query=workflow%3ACI
[ci-badge]: https://github.com/puripuri2100/yojson-rs/workflows/CI/badge.svg?branch=master
[source]: https://github.com/puripuri2100/yojson-rs
[source-badge]: https://img.shields.io/badge/source-github-blue
[license]: https://github.com/puripuri2100/yojson-rs/blob/master/LICENSE
[license-badge]: https://img.shields.io/badge/license-MIT-blue
This library parses [JSON data (yojson format)](https://mjambon.github.io/mjambon2016/yojson.html) into a nested Rust tree data structure.
# Yojson values
A value in Yojson is represented with the `Value` enum in this crate:
```rust
pub enum Value {
Null,
Bool(bool),
Integer(i64),
Float(f64),
String(String),
Assoc(Assoc),
Array(Array),
Tuple(Vec),
Variant(Variant),
}
```
The Yojson format is an extension of the JSON format. See ["Yojson format document"](https://mjambon.github.io/mjambon2016/yojson.html) for more information.
- Tuples: like JSON arrays but within parentheses instead of square brackets, such as `(1.23, 4.56)`.
- Variants without argument: `<"Foo">`.
- Variants with one argument: `<"Bar": 123>`.
- Unquoted field names and variants are accepted if they match the pattern `[A-Za-z][A-Za-z_0-9]*`: `{ x: , "#y": }`.
- Comments: `/* multiline comment */` and `// end-of-line comment`.
- Special numeric entities: `[ Infinity, -Infinity, NaN ]`.
# Parsing JSON
Parse JSON data.
```rust
use yojson_rs;
fn main () {
let json = r#"
{
x : 123,
y : {
"y1" : "abc\ndef\u0021",
"y2" : [null, 123.45, (12, "y3")]
},
z : NaN
}
"#;
assert!(yojson_rs::parser::parse(json).is_ok());
}
```
# Convert to a JSON string.
A data structure can be converted to a JSON string by `to_string`.
```rust
use yojson_rs;
fn main() {
let json_str = r#"
{
x : 123,
y : {
"y1" : "abc\ndef\u0021",
"y2" : [null, 123.45, (12, "y3")]
},
z : NaN
}
"#;
let json = yojson_rs::parser::parse(json_str).unwrap();
println!("{}", yojson_rs::to_string(json));
}
```
---
(c) 2021 Naoki Kaneko (a.k.a. "puripuri2100")