Struct ParameterPath 

pub struct ParameterPath { /* private fields */ }

Path to a Parameter nested inside a Parameterized type instance, composed of ParameterPathSegments.

Example

let value = vec![(4, 2)];
let paths = value.parameter_paths().map(|path| path.to_string()).collect::<Vec<_>>();
assert_eq!(paths, vec!["$[0].0", "$[0].1"]);

Implementations

impl ParameterPath

pub fn root() -> Self

Creates a new empty (i.e., root) ParameterPath.

pub fn len(&self) -> usize

Returns the number of ParameterPathSegments in this ParameterPath.

pub fn is_empty(&self) -> bool

Returns true if this ParameterPath contains no ParameterPathSegments (i.e., is the root path).

pub fn is_root(&self) -> bool

Returns true if this ParameterPath is the root path (i.e., is empty).

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

Returns true if this ParameterPath is a prefix of other.

pub fn segments( &self, ) -> impl DoubleEndedIterator<Item = &ParameterPathSegment> + '_

Returns an iterator over the ParameterPathSegments in this ParameterPath in root-to-leaf order.

pub fn with_segment(self, segment: ParameterPathSegment) -> Self

Returns a new ParameterPath with the provided ParameterPathSegment appended to it.

Example

let path = ParameterPath::root()
    .field("weights")
    .index(1)
    .tuple_index(0);
assert_eq!(path.to_string(), "$.weights[1].0");

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

Returns a new ParameterPath with a ParameterPathSegment::Field segment appended to the end of this ParameterPath.

pub fn variant(self, name: &'static str) -> Self

Returns a new ParameterPath with a ParameterPathSegment::Variant segment appended to the end of this ParameterPath.

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

Returns a new ParameterPath with a ParameterPathSegment::Index segment appended to the end of this ParameterPath.

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

Returns a new ParameterPath with a ParameterPathSegment::TupleIndex segment appended to the end of this ParameterPath.

pub fn key<K: Debug>(self, key: K) -> Self

Returns a new ParameterPath with a ParameterPathSegment::Key segment appended to the end of this ParameterPath.

Trait Implementations

impl Clone for ParameterPath

fn clone(&self) -> ParameterPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterPath

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

Formats the value using the given formatter.

impl Default for ParameterPath

fn default() -> ParameterPath

Returns the “default value” for a type.

impl Display for ParameterPath

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

Formats the value using the given formatter.

impl Hash for ParameterPath

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 ParameterPath

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

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

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

impl StructuralPartialEq for ParameterPath