Struct JsonPath 

pub struct JsonPath {
    pub first_key: String,
    pub rest: Vec<JsonPathItem>,
}

Fields

first_key: String

rest: Vec<JsonPathItem>

Implementations

impl JsonPath

pub fn value_get<'a>( &self, json_map: &'a Map<String, Value>, ) -> SmallVec<[&'a Value; 1]>

Get values at a given JSON path from a JSON map.

pub fn value_set<'a>( path: Option<&Self>, dest: &'a mut Map<String, Value>, src: &'a Map<String, Value>, )

Set values at a given JSON path in a JSON map.

pub fn value_remove( &self, json_map: &mut Map<String, Value>, ) -> SmallVec<[Value; 1]>

Remove values at a given JSON path from a JSON map. Returns values that were removed.

pub fn value_filter( json_map: &Map<String, Value>, filter: impl Fn(&Self, &Value) -> bool, ) -> Map<String, Value>

Filter values in a JSON map based on a predicate.

pub fn strip_wildcard_suffix(&self) -> Self

Remove the wildcard suffix from the path, if it exists. E.g. a.b[] -> a.b.

pub fn strip_prefix(&self, prefix: &Self) -> Option<Self>

If self starts with prefix, returns a new path with the prefix removed.

pub fn extend(&self, other: &Self) -> Self

Extend the path with another path.

pub fn array_key(&self) -> Self

Returns a new path with an array key appended to the end. E.g. a.b -> a.b[].

pub fn has_wildcard_suffix(&self) -> bool

pub fn check_include_pattern(&self, pattern: &Self) -> bool

Check if a path is included in a list of patterns.

Basically, it checks if either the pattern or path is a prefix of the other.

pub fn check_exclude_pattern(&self, pattern: &Self) -> bool

Check if a path should be excluded by a pattern.

Basically, it checks if pattern is a prefix of path, but not the other way around.

pub fn extend_or_new(base: Option<&Self>, other: &Self) -> Self

pub fn compatible(&self, other: &Self) -> bool

Check if a path is a compatible prefix of another path or vice versa.

pub fn is_affected_by_value_remove(&self, path_to_remove: &JsonPath) -> bool

Check if the path will be affected by a call to path_to_remove.value_remove(_).

pub fn is_affected_by_value_set( &self, payload: &Map<String, Value>, path_to_set: Option<&JsonPath>, ) -> bool

Check if the path will be affected by a call to path_to_set.value_set(_, payload).

pub fn filename(&self) -> String

Convert the path into a string suitable for use as a filename by adhering to the following restrictions: max length, limited character set, but still being relatively unique.

Trait Implementations

impl Clone for JsonPath

fn clone(&self) -> JsonPath

Returns a duplicate 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<'de> Deserialize<'de> for JsonPath

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

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 From<JsonPath> for IsEmptyCondition

fn from(key: JsonPath) -> Self

Converts to this type from the input type.

impl From<JsonPath> for IsNullCondition

fn from(key: JsonPath) -> Self

Converts to this type from the input type.

impl FromStr for JsonPath

type Err = ()

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 Hash for JsonPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for JsonPath

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for JsonPath

fn cmp(&self, other: &JsonPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for JsonPath

fn partial_cmp(&self, other: &JsonPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for JsonPath

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

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for JsonPath

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for JsonPath

impl StructuralPartialEq for JsonPath