https://github.com/jwodder/serde-json-fmt

Configurable formatting for serde_json serialization
https://github.com/jwodder/serde-json-fmt

available-on-crates-io json rust serde serde-json

Last synced: 20 days ago
JSON representation

Configurable formatting for serde_json serialization

• Host: GitHub
• URL: https://github.com/jwodder/serde-json-fmt
• Owner: jwodder
• License: mit
• Created: 2023-04-15T12:51:01.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-10T18:11:54.000Z (9 months ago)
• Last Synced: 2024-04-10T22:27:23.568Z (7 months ago)
• Topics: available-on-crates-io, json, rust, serde, serde-json
• Language: Rust
• Homepage:
• Size: 51.8 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![CI Status](https://github.com/jwodder/serde-json-fmt/actions/workflows/test.yml/badge.svg)](https://github.com/jwodder/serde-json-fmt/actions/workflows/test.yml)

[![codecov.io](https://codecov.io/gh/jwodder/serde-json-fmt/branch/master/graph/badge.svg)](https://codecov.io/gh/jwodder/serde-json-fmt)

[![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.67-orange)](https://www.rust-lang.org)

[![MIT License](https://img.shields.io/github/license/jwodder/serde-json-fmt.svg)](https://opensource.org/licenses/MIT)

[GitHub](https://github.com/jwodder/serde-json-fmt) | [crates.io](https://crates.io/crates/serde-json-fmt) | [Documentation](https://docs.rs/serde-json-fmt) | [Issues](https://github.com/jwodder/serde-json-fmt/issues) | [Changelog](https://github.com/jwodder/serde-json-fmt/blob/master/CHANGELOG.md)

The `serde-json-fmt` crate lets you create custom

[`serde_json`](https://crates.io/crates/serde_json) formatters with the

indentation, separators, and ASCII requirements of your choice.

`serde_json` itself only directly provides the ability to produce JSON in

either "compact" form or "pretty" form, with the only customizable aspect being

the string used for pretty indentation.  `serde-json-fmt` complements

`serde_json` to let you also customize the whitespace around commas & colons

and whether to escape non-ASCII characters.

Examples

========

Say you want to serialize a value in one-line "compact" form, but you want a

space after each colon & comma, something that `serde_json`'s compact form

doesn't do.  `serde-json-fmt` lets you do that:

```rust

use serde_json::json;

use serde_json_fmt::JsonFormat;

let value = json!({

    "colors": ["red", "blue", "taupe"],

    "sub": {

        "name": "Foo",

        "on": true,

        "size": 17

    }

});

let s = JsonFormat::new()

    .comma(", ")

    .unwrap()

    .colon(": ")

    .unwrap()

    .format_to_string(&value)

    .unwrap();

assert_eq!(

    s,

    r#"{"colors": ["red", "blue", "taupe"], "sub": {"name": "Foo", "on": true, "size": 17}}"#

);

```

Say you want to format a value in multiline "pretty" form, but using four-space

indents and with all non-ASCII characters encoded as `\uXXXX` escape sequences.

`serde-json-fmt` lets you do that:

```rust

use serde_json::json;

use serde_json_fmt::JsonFormat;

let value = json!({

    "emojis": {

        "goat":"🐐",

        "pineapple": "🍍",

        "smile": "😀",

    },

    "greek": {

        "α": "alpha",

        "β": "beta",

        "γ": "gamma",

    }

});

let s = JsonFormat::pretty()

    .indent_width(Some(4))

    .ascii(true)

    .format_to_string(&value)

    .unwrap();

assert_eq!(s, r#"{

    "emojis": {

        "goat": "\ud83d\udc10",

        "pineapple": "\ud83c\udf4d",

        "smile": "\ud83d\ude00"

    },

    "greek": {

        "\u03b1": "alpha",

        "\u03b2": "beta",

        "\u03b3": "gamma"

    }

}"#);

```