Struct Path 

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

Represents a path to a field in a nested structure.

Examples: "root", "user.name", "items[3].id", "config.db.host"

Examples

use diffo::Path;

let root = Path::root();
let user_name = root.field("user").field("name");
assert_eq!(user_name.as_str(), "user.name");

let item_id = root.field("items").index(3).field("id");
assert_eq!(item_id.as_str(), "items[3].id");

Implementations

impl Path

pub fn root() -> Self

Create a root path.

Examples

use diffo::Path;

let root = Path::root();
assert_eq!(root.as_str(), "");

pub fn field(&self, name: &str) -> Self

Append a field name to the path.

Examples

use diffo::Path;

let path = Path::root().field("user").field("name");
assert_eq!(path.as_str(), "user.name");

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

Append an array index to the path.

Examples

use diffo::Path;

let path = Path::root().field("items").index(3);
assert_eq!(path.as_str(), "items[3]");

pub fn as_str(&self) -> &str

Get the path as a string slice.

Examples

use diffo::Path;

let path = Path::root().field("user");
assert_eq!(path.as_str(), "user");

pub fn to_json_pointer(&self) -> String

Convert path to JSON Pointer format (RFC 6901).

Examples

use diffo::Path;

let path = Path::root().field("user").field("name");
assert_eq!(path.to_json_pointer(), "/user/name");

let indexed = Path::root().field("items").index(0);
assert_eq!(indexed.to_json_pointer(), "/items/0");

pub fn depth(&self) -> usize

Calculate the depth of the path (number of components).

Examples

use diffo::Path;

assert_eq!(Path::root().depth(), 0);
assert_eq!(Path::root().field("user").depth(), 1);
assert_eq!(Path::root().field("user").field("name").depth(), 2);
assert_eq!(Path::root().field("items").index(0).depth(), 2);

Trait Implementations

impl AsRef<str> for Path

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Path

fn clone(&self) -> Path

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Display for Path

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

Formats the value using the given formatter.

impl Hash for Path

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 Path

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

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

fn partial_cmp(&self, other: &Path) -> 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 Eq for Path

impl StructuralPartialEq for Path