Struct AuthoredPath 

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

A path in the authored JSON: keys and indices, displayed as v3 spelled them, tasks[1].tasks[0].id, function.input.mappings[3].logic. The root displays as the empty string.

A key that could not otherwise be read back, one that is empty or holds a ., [, ] or ", displays as a JSON string in brackets: function.input.fields["a.b"], [""]. FromStr reads every displayed form back, and a path serializes as it displays.

Implementations

impl AuthoredPath

pub fn root() -> Self

The empty path, the document itself.

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

The segments, outermost first.

pub fn is_root(&self) -> bool

Is this the root?

pub fn push(&mut self, seg: impl Into<PathSeg>)

Appends a segment.

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

Removes and returns the last segment.

pub fn join(&self, seg: impl Into<PathSeg>) -> Self

A copy with one more segment.

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

self followed by rest.

Trait Implementations

impl Clone for AuthoredPath

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 AuthoredPath

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

Formats the value using the given formatter.

impl Default for AuthoredPath

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthoredPath

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

Deserialize this value from the given Serde deserializer.

impl Display for AuthoredPath

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

Formats the value using the given formatter.

impl Eq for AuthoredPath

impl FromStr for AuthoredPath

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

The inverse of Display: a bare key holds no ., [, ] or ", and a bracketed one is a JSON string.

type Err = ParsePathError

The associated error which can be returned from parsing.

impl Hash for AuthoredPath

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 AuthoredPath

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 AuthoredPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AuthoredPath

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 AuthoredPath

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuthoredPath