Struct JsonPath

pub struct JsonPath(/* private fields */);

A parsed JSON Path query string

This type represents a valid, parsed JSON Path query string. Please refer to the JSONPath standard (RFC 9535) for the details on what constitutes a valid JSON Path query.

Usage

A JsonPath can be parsed directly from an &str using the parse method:

let path = JsonPath::parse("$.foo.*").expect("valid JSON Path");

It can then be used to query serde_json::Value’s with the query method:

let value = json!({"foo": [1, 2, 3, 4]});
let nodes = path.query(&value);
assert_eq!(nodes.all(), vec![1, 2, 3, 4]);

Implementations

impl JsonPath

pub fn parse(path_str: &str) -> Result<Self, ParseError>

Create a JsonPath by parsing a valid JSON Path query string

Example

let path = JsonPath::parse("$.foo[1:10:2].baz").expect("valid JSON Path");

pub fn query<'b>(&self, value: &'b Value) -> NodeList<'b>

Query a serde_json::Value using this JsonPath

Example

let value = json!({"foo": [1, 2, 3, 4]});
let path = JsonPath::parse("$.foo[::2]")?;
let nodes = path.query(&value);
assert_eq!(nodes.all(), vec![1, 3]);

pub fn query_located<'b>(&self, value: &'b Value) -> LocatedNodeList<'b>

Query a serde_json::Value using this JsonPath to produce a LocatedNodeList

Example

let value = json!({"foo": {"bar": 1, "baz": 2}});
let path = JsonPath::parse("$.foo.*")?;
let query = path.query_located(&value);
let nodes: Vec<&Value> = query.nodes().collect();
assert_eq!(nodes, vec![1, 2]);
let locs: Vec<String> = query
    .locations()
    .map(|loc| loc.to_string())
    .collect();
assert_eq!(locs, ["$['foo']['bar']", "$['foo']['baz']"]);

Trait Implementations

impl Clone for JsonPath

fn clone(&self) -> JsonPath

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JsonPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JsonPath

fn default() -> JsonPath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonPath

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JsonPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for JsonPath

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for JsonPath

fn eq(&self, other: &JsonPath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JsonPath

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for JsonPath

impl StructuralPartialEq for JsonPath