Enum PathSegment 

#[non_exhaustive]
pub enum PathSegment {
    Field(&'static str),
    Index(usize),
    MapEntry(usize),
    MapKey,
    MapValue,
}

One location segment in a validation path.

Segments sort by variant in the order listed below, then by their field label or numeric index within a variant.

Examples

use qubit_validator::PathSegment;

let field = PathSegment::Field("profile");
assert_eq!(format!("{field:?}"), "Field(<redacted>)");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Field(&'static str)

A declared field name.

Tuple Fields

0: &'static str

Program-supplied field label; debug formatting redacts it.

Index(usize)

A sequence element index.

Tuple Fields

0: usize

Zero-based sequence index.

MapEntry(usize)

An opaque map entry index.

Tuple Fields

0: usize

Opaque map-entry position, never the raw map key.

MapKey

The key side of a map entry.

MapValue

The value side of a map entry.

Trait Implementations

impl Clone for PathSegment

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 PathSegment

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

Formats structural path data while redacting field labels.

impl Eq for PathSegment

impl Hash for PathSegment

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 PathSegment

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 PathSegment

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PathSegment

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 PathSegment