fjson

Crates.iofjson
lib.rsfjson
version0.3.1
sourcesrc
created_at2023-01-06 03:42:15.993678
updated_at2023-01-19 17:15:20.475829
descriptionA library for parsing and formatting json with C-style comments and trailing commas
homepage
repositoryhttps://github.com/ryanfowler/fjson
max_upload_size
id751979
size83,413
Ryan Fowler (ryanfowler)

documentation

https://docs.rs/fjson

README

fjson

A Rust library for parsing and formatting JSON with C-style comments and trailing commas

Usage

Given the following input:

// This is a JSON value with comments and trailing commas
{

    /* The project name is fjson */
    "project": "fjson",
    "language": "Rust",
    "license": [
        "MIT",
    ],


  // This project is public.
    "public": true,
}

Format to JSONC

Format to pretty JSONC, intended for human viewing:

let output = fjson::to_jsonc(input).unwrap();
println!("{}", output);

Prints:

// This is a JSON value with comments and trailing commas
{
  /* The project name is fjson */
  "project": "fjson",
  "language": "Rust",
  "license": ["MIT"],

  // This project is public.
  "public": true
}

Format to valid, pretty JSON

Format to pretty JSON, intended for human viewing:

let output = fjson::to_json(input)?;
println!("{}", output);

Prints:

{
  "project": "fjson",
  "language": "Rust",
  "license": ["MIT"],
  "public": true
}

Format to valid, compact JSON

Format to compact JSON, intended for computer consumption:

let output = fjson::to_json_compact(input)?;
println!("{}", output);

Prints:

{"project":"fjson","language":"Rust","license":["MIT"],"public":true}

Deserialize with Serde

To parse JSON with C-style comments and trailing commas, but deserialize via serde, this can be accomplished with the following:

use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct Project {
    project: String,
    language: String,
    license: Vec<String>,
    public: bool,
}

let output = fjson::to_json_compact(input)?;
let project: Project = serde_json::from_str(&output)?;
println!("{:#?}", project);
Commit count: 58

cargo fmt