#json #pointer #pointers #serde-json #json-pointer

json-pointer

A crate for parsing and using JSON pointers, as specified in RFC 6901

7 releases

0.3.4 Sep 5, 2020
0.3.3 Sep 5, 2020
0.3.2 Jun 1, 2017
0.3.1 May 30, 2017
0.1.0 May 26, 2017

#167 in Encoding

Download history 3597/week @ 2021-08-12 2579/week @ 2021-08-19 3587/week @ 2021-08-26 1702/week @ 2021-09-02 4101/week @ 2021-09-09 4674/week @ 2021-09-16 3327/week @ 2021-09-23 3319/week @ 2021-09-30 3702/week @ 2021-10-07 5279/week @ 2021-10-14 4532/week @ 2021-10-21 4685/week @ 2021-10-28 2833/week @ 2021-11-04 2619/week @ 2021-11-11 2940/week @ 2021-11-18 1290/week @ 2021-11-25

10,366 downloads per month
Used in 38 crates (8 directly)

MIT license

18KB
287 lines

json-pointer

A crate for parsing and using JSON pointers, as specified in RFC 6901. Unlike the pointer method built into serde_json, this handles both validating JSON Pointers before use and the URI Fragment Identifier Representation.

pipeline status crates.io Documentation

Creating a JSON Pointer

JSON pointers can be created with a literal [&str], or parsed from a String.

let from_strs = JsonPointer::new([
    "foo",
    "bar",
]);
let parsed = "/foo/bar".parse::<JsonPointer<_, _>>().unwrap();

assert_eq!(from_strs.to_string(), parsed.to_string());
}

Using a JSON Pointer

The JsonPointer type provides .get() and .get_mut(), to get references and mutable references to the appropriate value, respectively.

let ptr = "/foo/bar".parse::<JsonPointer<_, _>>().unwrap();

let document = json!({
    "foo": {
        "bar": 0,
        "baz": 1,
    },
    "quux": "xyzzy"
});

let indexed = ptr.get(&document).unwrap();

assert_eq!(indexed, &json!(0));

URI Fragment Identifier Representation

JSON Pointers can be embedded in the fragment portion of a URI. This is the reason why most JSON pointer libraries require a # character at the beginning of a JSON pointer. The crate will detect the leading # as an indicator to parse in URI Fragment Identifier Representation. Note that this means that this crate does not support parsing full URIs.

let str_ptr = "/f%o".parse::<JsonPointer<_, _>>().unwrap();
let uri_ptr = "#/f%25o".parse::<JsonPointer<_, _>>().unwrap();

assert_eq!(str_ptr, uri_ptr);

Dependencies

~445–710KB
~15K SLoC