json-commons

A set of JSON common tools in Rust

This library uses the json

Usage

use json_commons::JsonCommons;


fn main() {
    let jsonc = JsonCommons::new();
}

Parsing Features

Parsing features allows to read a JSON content but in case of failure a panic error occurs

Reading a JSON String

let content = "{\"car\": {\"model\": \"Gurgel Itaipu E400\", \"color\": \"red\"}}";
let json = jsonc.read_str(content);

Reading a JSON File

let path = "/user/docs/myfile.json";
let json = jsonc.read_file(path);

Dotted Paths Features

The following examples uses this json content

{
  "car": {
    "model": "Gurgel Itaipu E400",
    "color": "red"
  }
}

Path Exists

You can check if the path exists

let json = jsonc.read_str(content);

jsonc.path_exists("car", json); // The output is True
jsonc.path_exists("car.model", json); // The output is True

jsonc.path_exists("car.name", json); // The output is False
jsonc.path_exists("person", json); // The output is False

Get Path

You can get any path as an optional

let json = jsonc.read_str(content);

jsonc.get_path("car", json); // The output is Ok, containing a JsonValue
jsonc.get_path("car.model", json); // The output is Ok, containing a JsonValue

jsonc.get_path("car.name", json); // The output is None
jsonc.get_path("person", json); // The output is None

Dotted Paths with Lists

You can get a child element by accessing via index, see this example

{
  "car": {
  	"model": "Gurgel Itaipu E400",
  	"variants": [
      		{
      			"fuel": "gasoline",
      			"color": "yellow"
      		},
      		{
      			"fuel": "eletric",
      			"color": "red"
      		}
      	]
    }
}

let json = jsonc.read_str(content);

jsonc.get_path("car.variants", json); // The output is Ok, containing a JsonValue
jsonc.get_path("car.variants.0", json); // The output is Ok, containing a JsonValue
jsonc.get_path("car.variants.1.fuel", json); // The output is Ok, containing a JsonValue

jsonc.get_path("car.variants.99", json); // The output is None
jsonc.get_path("car.variants.one", json); // The output is None

List Features

Consider the following content

{
  "cars": [
    {
      "model": "Gurgel Itaipu E400",
      "color": "red"
    },
    {
      "model": "Gurgel Itaipu E400",
      "color": "brown"
    }
  ]
}

Parse to Vec

You can parse a list to a vec


let json = jsonc.read_str(content);

let cars = jsonc.get_path("cars", json).unwrap();
jsonc.parse_to_vec(cars); // The output is a vec of JsonValue, with len 2

json-commons 0.2.0