Struct RefPath 

pub struct RefPath { /* private fields */ }

A parsed path: dotted keys plus bracket array indices, a.b[2].c.

The one spelling over Seg. References parse it directly; --set’s path parses it too, and its write-side caller then runs try_into_keys, which rejects any Index step — reading an array element has one obvious meaning, writing one does not. Empty paths and empty segments are unrepresentable: both from_str and from_keys reject them.

Display is render_path. Not injective with respect to document keys: a key literally spelled a[0] exists, but this grammar reads it as a key and an index — the same accepted loss as keys containing a literal dot.

Implementations

impl RefPath

pub fn from_keys(keys: Vec<String>) -> Result<Self, PathError>

Build from key strings. Rejects an empty path or any empty segment.

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

The segments as steps.

pub fn into_segs(self) -> Vec<Seg>

The segments as steps, zero-copy.

pub fn try_into_keys(self) -> Result<Vec<String>, PathError>

The owned key strings, checked all-key.

The one write-side predicate: a caller that assigns into a document takes keys one per segment, so an Index step fails here rather than at the merge — before any file is read, and with the whole path rendered into the error.

Trait Implementations

impl Clone for RefPath

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefPath

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

Formats the value using the given formatter.

impl Display for RefPath

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

Formats the value using the given formatter.

impl Eq for RefPath

impl FromStr for RefPath

fn from_str(body: &str) -> Result<Self, Self::Err>

Grammar: a leading key, then any mix of .key and [N] steps, where a key is a run of anything but .[] and N a bare usize.

type Err = PathError

The associated error which can be returned from parsing.

impl Hash for RefPath

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 RefPath

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RefPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RefPath

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 StructuralPartialEq for RefPath