Struct Path 

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

A complete path into a JSON structure.

Paths are immutable sequences of segments. Use builder methods to construct paths incrementally.

Examples

use tirea_state::Path;

let path = Path::root().key("users").index(0).key("name");
assert_eq!(path.len(), 3);

Implementations

impl Path

pub fn new() -> Self

Create an empty path (root).

pub fn root() -> Self

Create an empty path (alias for new).

pub fn from_segments(segments: Vec<Seg>) -> Self

Create a path from a vector of segments.

pub fn with_capacity(capacity: usize) -> Self

Create a path with pre-allocated capacity.

pub fn key(self, k: impl Into<String>) -> Self

Append a key segment and return self (builder pattern).

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

Append an index segment and return self (builder pattern).

pub fn push(&mut self, seg: Seg)

Push a segment onto the path (mutating).

pub fn push_key(&mut self, k: impl Into<String>)

Push a key segment onto the path (mutating).

pub fn push_index(&mut self, i: usize)

Push an index segment onto the path (mutating).

pub fn pop(&mut self) -> Option<Seg>

Pop the last segment from the path.

pub fn segments(&self) -> &[Seg]

Get the segments of this path.

pub fn segments_mut(&mut self) -> &mut Vec<Seg>

Get a mutable reference to the segments.

pub fn is_empty(&self) -> bool

Check if this path is empty (root).

pub fn len(&self) -> usize

Get the number of segments in this path.

pub fn first(&self) -> Option<&Seg>

Get the first segment.

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

Get the last segment.

pub fn join(&self, other: &Path) -> Path

Join this path with another path.

pub fn with_segment(&self, seg: Seg) -> Path

Append a segment and return a new path (non-mutating builder).

pub fn is_prefix_of(&self, other: &Path) -> bool

Check if this path is a prefix of another path.

A path is a prefix of another if all of its segments match the beginning of the other path’s segments.

Examples

use tirea_state::path;

let parent = path!("user");
let child = path!("user", "name");

assert!(parent.is_prefix_of(&child));
assert!(!child.is_prefix_of(&parent));
assert!(parent.is_prefix_of(&parent)); // A path is a prefix of itself

pub fn extend(&mut self, other: &Path)

Extend this path with segments from another path.

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

Get the parent path (path without the last segment).

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

Check if this path starts with another path.

pub fn slice(&self, start: usize, end: usize) -> Path

Get a slice of segments from start to end.

pub fn iter(&self) -> impl Iterator<Item = &Seg>

Iterate over the segments.

Trait Implementations

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 Default for Path

fn default() -> Path

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Path

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Path

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

Formats the value using the given formatter.

impl FromIterator<Seg> for Path

fn from_iter<I: IntoIterator<Item = Seg>>(iter: I) -> Self

Creates a value from an iterator.

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 Index<usize> for Path

type Output = Seg

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Path

type Item = &'a Seg

The type of the elements being iterated over.

type IntoIter = Iter<'a, Seg>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Path

type Item = Seg

The type of the elements being iterated over.

type IntoIter = IntoIter<Seg>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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 Serialize for Path

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 Path

impl StructuralPartialEq for Path