FieldPath

Struct FieldPath 

Source
pub struct FieldPath { /* private fields */ }
Expand description

A path to a field in a nested structure.

§Example

use skp_validator_core::FieldPath;

// Build path: user.addresses[0].city
let path = FieldPath::new()
    .push_field("user")
    .push_field("addresses")
    .push_index(0)
    .push_field("city");

assert_eq!(path.to_string(), "user.addresses[0].city");

Implementations§

Source§

impl FieldPath

Source

pub fn new() -> Self

Create an empty field path

Source

pub fn from_field(name: impl Into<String>) -> Self

Create a path from a single field name

Source

pub fn is_empty(&self) -> bool

Check if the path is empty (root level)

Source

pub fn len(&self) -> usize

Get the number of segments

Source

pub fn push_field(self, name: impl Into<String>) -> Self

Add a field segment and return self (builder pattern)

Source

pub fn push_index(self, idx: usize) -> Self

Add an index segment and return self (builder pattern)

Source

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

Add a key segment and return self (builder pattern)

Source

pub fn append_field(&mut self, name: impl Into<String>)

Add a field segment in place

Source

pub fn append_index(&mut self, idx: usize)

Add an index segment in place

Source

pub fn append_key(&mut self, key: impl Into<String>)

Add a key segment in place

Source

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

Get the segments as a slice

Source

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

Get the parent path (without the last segment)

Source

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

Get the last segment (leaf field name)

Source

pub fn last_field_name(&self) -> Option<&str>

Get the field name of the last segment if it’s a Field

Source

pub fn child_field(&self, name: impl Into<String>) -> Self

Create a child path with a field segment

Source

pub fn child_index(&self, idx: usize) -> Self

Create a child path with an index segment

Source

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

Create a child path with a key segment

Source

pub fn to_dot_notation(&self) -> String

Convert to a dot-notation string

Source

pub fn to_json_pointer(&self) -> String

Convert to a JSON pointer string (RFC 6901)

Trait Implementations§

Source§

impl Clone for FieldPath

Source§

fn clone(&self) -> FieldPath

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FieldPath

Source§

fn default() -> FieldPath

Returns the “default value” for a type. Read more
Source§

impl Display for FieldPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&str> for FieldPath

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for FieldPath

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl Hash for FieldPath

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FieldPath

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for FieldPath

Source§

impl StructuralPartialEq for FieldPath

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.