Struct jsonpath_plus::JsonPath

pub struct JsonPath { /* private fields */ }

A compiled JSON path. Can be used to match against items any number of times, preventing recompilation of the same pattern many times.

Implementations

impl JsonPath

pub fn compile(pattern: &str) -> Result<JsonPath, ParseError>

Compile a JSON path, which can be used to match items multiple times.

Errors

• If the provided pattern fails to parse as a valid JSON path

pub fn find<'a>(&self, value: &'a Value) -> Vec<&'a Value>

Find this pattern in the provided JSON value

pub fn find_paths(&self, value: &Value) -> Vec<IdxPath>

Find this pattern in the provided JSON value, and return the shortest paths to all found values as a chain of indices

pub fn delete(&self, value: &Value) -> Value

Delete all items matched by this pattern on the provided JSON value, and return the resulting object

pub fn delete_on(&self, value: &mut Value)

Delete all items matched by this pattern on the provided JSON value, operating in-place

pub fn replace(&self, value: &Value, f: impl FnMut(&Value) -> Value) -> Value

Replace items matched by this pattern on the provided JSON value, filling them with the value returned by the provided function, then return the resulting object

pub fn replace_on(&self, value: &mut Value, f: impl FnMut(&Value) -> Value)

Replace items matched by this pattern on the provided JSON value, filling them the value returned by the provided function, operating in-place

pub fn try_replace(
    &self,
    value: &Value,
    f: impl FnMut(&Value) -> Option<Value>
) -> Value

Replace or delete items matched by this pattern on the provided JSON value. Replaces if the provided method returns Some, deletes if the provided method returns None. This method then returns the resulting object

pub fn try_replace_on(
    &self,
    value: &mut Value,
    f: impl FnMut(&Value) -> Option<Value>
)

Replace or delete items matched by this pattern on the provided JSON value. Replaces if the provided method returns Some, deletes if the provided method returns None. This method operates in-place on the provided value

pub fn find_str(&self, str: &str) -> Result<Vec<Value>, Error>

Find this pattern in the provided JSON string

Errors

• If the provided value fails to deserialize

pub fn delete_str(&self, str: &str) -> Result<Value, Error>

Delete items matching this pattern in the provided JSON string

Errors

• If the provided value fails to deserialize

pub fn replace_str(
    &self,
    str: &str,
    f: impl FnMut(&Value) -> Value
) -> Result<Value, Error>

Replace items matching this pattern in the provided JSON string

Errors

• If the provided value fails to deserialize

pub fn try_replace_str(
    &self,
    str: &str,
    f: impl FnMut(&Value) -> Option<Value>
) -> Result<Value, Error>

Replace or delete items matching this pattern in the provided JSON string

Errors

• If the provided value fails to deserialize