Struct FieldPath 

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

Available on crate features input-toml or input-yaml only.

The steps from a document’s root down to a field.

Build one with FieldPath::root, FieldPath::key, and FieldPath::index, or, with the validate feature, from garde’s path with FieldPath::from. Input::place turns it into a line and column.

A key is kept as written, so FieldPath::root().key("files").key("docs/**/*.md") names one key of files, not four. Display joins the steps the way garde prints a field, files.docs/**/*.md, which cannot tell a key that holds a dot from nesting. It is for people, and nothing reads it back.

Implementations

impl FieldPath

pub fn root() -> Self

The document’s root.

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

This path extended by a mapping or table key.

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

This path extended by a sequence or array index.

pub fn steps(&self) -> &[Step]

The steps from the root, in order.

Trait Implementations

impl Clone for FieldPath

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 FieldPath

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

Formats the value using the given formatter.

impl Default for FieldPath

fn default() -> Self

Returns the “default value” for a type.

impl Display for FieldPath

The path as garde prints a field: keys joined by ., indexes in brackets, and nothing for the root.

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

Formats the value using the given formatter.

impl Eq for FieldPath

impl From<&Path> for FieldPath

Available on crate feature validate only.

The steps of garde’s path, read from its parts and never from its printed string, so a key that holds a . stays one step.

A component garde marks as an index becomes Step::Index, one it marks as a key becomes Step::Key, and one it marks with no key, which names a wrapper such as a one-field tuple struct, is dropped. An index component that is not a number is kept as a key.

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl Hash for FieldPath

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 PartialEq for FieldPath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FieldPath