Struct Path 

pub struct Path<T, V> { /* private fields */ }

A path into a document, what its index can be asked, and the type of the value that lives there.

Written by #[derive(Yo)] as a constant per indexed field, so a query names the field rather than spelling a string the compiler cannot check. A field marked #[yo(ordered)] gets an Ordered instead, which is the same thing with ranges on it.

Implementations

impl<T, V> Path<T, V>

pub const fn new(path: &'static str, kind: IndexKind) -> Path<T, V>

A path and what its index answers.

The derive calls this. Calling it by hand is allowed and is how a path into a nested object is reached until the derive learns to follow one, but nothing checks that the collection has the index you named until the query runs.

pub const fn path(&self) -> &'static str

The path, as $.status.

pub const fn kind(&self) -> IndexKind

What the index on this path can be asked.

Trait Implementations

impl<T, V> Clone for Path<T, V>

fn clone(&self) -> Path<T, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, V> Copy for Path<T, V>

impl<T, V> Debug for Path<T, V>

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

Formats the value using the given formatter.

impl<T, V> From<Ordered<T, V>> for Path<T, V>

An ordered path answers equality too, so everything that takes a Path takes one of these.

fn from(o: Ordered<T, V>) -> Path<T, V>

Converts to this type from the input type.