#json #patch #document #serde-json #rfc #merge #path

json-patch

RFC 6902, JavaScript Object Notation (JSON) Patch

13 releases (3 stable)

1.2.0 Oct 9, 2023
1.0.0 Mar 31, 2023
0.3.0 Dec 11, 2022
0.2.6 Aug 25, 2019
0.2.1 Nov 3, 2017

#60 in Encoding

Download history 49542/week @ 2023-12-23 86949/week @ 2023-12-30 127078/week @ 2024-01-06 131118/week @ 2024-01-13 135491/week @ 2024-01-20 120709/week @ 2024-01-27 130089/week @ 2024-02-03 128999/week @ 2024-02-10 137231/week @ 2024-02-17 153898/week @ 2024-02-24 141011/week @ 2024-03-02 157776/week @ 2024-03-09 154976/week @ 2024-03-16 161034/week @ 2024-03-23 161145/week @ 2024-03-30 134900/week @ 2024-04-06

638,050 downloads per month
Used in 244 crates (44 directly)

MIT/Apache

34KB
561 lines

crates.io crates.io Build Codecov

json-patch

A JSON Patch (RFC 6902) and JSON Merge Patch (RFC 7396) implementation for Rust.

Usage

Add this to your Cargo.toml:

[dependencies]
json-patch = "*"

Examples

Create and patch document using JSON Patch:

#[macro_use]
use json_patch::{Patch, patch};
use serde_json::{from_value, json};

let mut doc = json!([
    { "name": "Andrew" },
    { "name": "Maxim" }
]);

let p: Patch = from_value(json!([
  { "op": "test", "path": "/0/name", "value": "Andrew" },
  { "op": "add", "path": "/0/happy", "value": true }
])).unwrap();

patch(&mut doc, &p).unwrap();
assert_eq!(doc, json!([
  { "name": "Andrew", "happy": true },
  { "name": "Maxim" }
]));

Create and patch document using JSON Merge Patch:

#[macro_use]
use json_patch::merge;
use serde_json::json;

let mut doc = json!({
  "title": "Goodbye!",
  "author" : {
    "givenName" : "John",
    "familyName" : "Doe"
  },
  "tags":[ "example", "sample" ],
  "content": "This will be unchanged"
});

let patch = json!({
  "title": "Hello!",
  "phoneNumber": "+01-123-456-7890",
  "author": {
    "familyName": null
  },
  "tags": [ "example" ]
});

merge(&mut doc, &patch);
assert_eq!(doc, json!({
  "title": "Hello!",
  "author" : {
    "givenName" : "John"
  },
  "tags": [ "example" ],
  "content": "This will be unchanged",
  "phoneNumber": "+01-123-456-7890"
}));

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0.7–1.7MB
~38K SLoC