json-pointer

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

Build Status crates.io Documentation

Creating a JSON Pointer

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

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

asserteq!(fromstrs.tostring(), parsed.tostring()); } ```

Using a JSON Pointer

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

```rust let ptr = "/foo/bar".parse::>().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.

```rust let strptr = "/f%o".parse::>().unwrap(); let uriptr = "#/f%25o".parse::>().unwrap();

asserteq!(strptr, uri_ptr); ```