Struct DocPath 

pub struct DocPath { /* private fields */ }

Implementations

impl DocPath

pub fn new(expr: impl Into<String>) -> Result<Self>

Construct a new document path from the provided string path

pub fn new_unwrap(expr: &'static str) -> Self

Infallible construction for when the expression is statically known, intended for unit tests.

Invalid expressions will still cause panics.

pub fn empty() -> Self

Construct a new DocPath with an empty expression.

Warning: do not call any of the push_* methods on this DocPath, as that would create an expression with invalid syntax (because it would be missing the Root token).

pub fn root() -> Self

Construct a new DocPath with the Root token.

pub fn body() -> Self

Construct a new DocPath for $.body

pub fn from_tokens<I>(tokens: I) -> Self

where I: IntoIterator<Item = PathToken>,

Construct a new DocPath from a list of tokens

pub fn tokens(&self) -> &Vec<PathToken>

Return the list of tokens that comprise this path.

pub fn len(&self) -> usize

Return the length, in parsed tokens.

pub fn last(&self) -> Option<PathToken>

Returns the last item in the path. Will panic if the path is empty.

pub fn first_field(&self) -> Option<&str>

Extract the string contents of the first Field token. For use with Header and Query DocPaths.

pub fn last_field(&self) -> Option<&str>

Extract the string contents of the last Field token.

pub fn is_root(&self) -> bool

If this path is the root path (it has only one element, the root token $).

pub fn is_wildcard(&self) -> bool

The path is a wildcard path if it ends in a star (*)

pub fn path_weight(&self, path: &[&str]) -> (usize, usize)

Calculates the path weight for this path expression and a given path. Returns a tuple of the calculated weight and the number of path tokens matched.

pub fn matches_path(&self, path: &[&str]) -> bool

If this path matches the given path. It will match if the calculated path weight is greater than zero (which means at least one token matched).

pub fn matches_path_exactly(&self, path: &[&str]) -> bool

If the path matches the given path (the calculated path weight is greater than zero) and both paths have the same length.

pub fn join(&self, part: impl Into<String>) -> Self

Creates a new path by cloning this one and pushing the string onto the end

pub fn join_index(&self, index: usize) -> Self

Creates a new path by cloning this one and joining the index onto the end. Paths that end with * will have the * replaced with the index.

pub fn join_field<S: Into<String>>(&self, name: S) -> Self

Creates a new path by cloning this one and joining the field onto the end. Paths that end with * will have the * replaced with the field.

pub fn push_field(&mut self, field: impl Into<String>) -> &mut Self

Mutates this path by pushing a field value onto the end.

pub fn push_index(&mut self, index: usize) -> &mut Self

Mutates this path by pushing an index value onto the end.

pub fn push_star(&mut self) -> &mut Self

Mutates this path by pushing a star value onto the end.

pub fn push_star_index(&mut self) -> &mut Self

Mutates this path by pushing a star index value onto the end.

pub fn push(&mut self, path_token: PathToken) -> &mut Self

Mutates this path by pushing a path token onto the end.

pub fn push_path(&mut self, path: &DocPath) -> &mut Self

Mutates this path by pushing another path onto the end. Will drop the root marker from the other path

pub fn to_vec(&self) -> Vec<String>

Convert this path to a vector of strings

pub fn parent(&self) -> Option<Self>

Return the parent path from this one

pub fn to_lower_case(&self) -> DocPath

Returns a copy of this path will all parts lower case

pub fn as_json_pointer(&self) -> Result<String>

Converts this path into a JSON pointer RFC6901.

pub fn ends_with(&self, suffix: &str) -> bool

If this path (as a string) ends with the given string

pub fn starts_with(&self, prefix: &str) -> bool

If this path (as a string) starts with the given string

pub fn drop(&self, n: usize) -> Self

Creates a new path with the last n parts removed.

Trait Implementations

impl Clone for DocPath

fn clone(&self) -> DocPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocPath

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

Formats the value using the given formatter.

impl Eq for DocPath

impl From<&DocPath> for String

fn from(doc_path: &DocPath) -> String

Converts to this type from the input type.

impl From<&DocPath> for DocPath

fn from(value: &DocPath) -> Self

Converts to this type from the input type.

impl From<DocPath> for String

fn from(doc_path: DocPath) -> String

Converts to this type from the input type.

impl Hash for DocPath

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 Ord for DocPath

fn cmp(&self, other: &Self) -> 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 DocPath

fn eq(&self, other: &Self) -> 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 DocPath

fn partial_cmp(&self, other: &Self) -> 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 DocPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&String> for DocPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: &String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for DocPath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for DocPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: String) -> Result<Self, Self::Error>

Performs the conversion.