Struct TokenPath 

pub struct TokenPath { /* private fields */ }

Where one captured token sits, as the index route from the root of the declared input.

The route is unique by construction: [3, 0, 5] is the sixth token of the first token of the fourth top-level token, and nothing else in the tree spells that. It is stable under everything a span is not stable under — which producer read the input, where the file moved, how the source was formatted — so two captures of one declaration agree on every route.

Implementations

impl TokenPath

pub const fn root() -> Self

The root route: the declared input itself, before any step into it.

pub fn stepped(&self, index: u32) -> Result<Self, CaptureBound>

The route to one token of the group this route names.

Errors

Returns CaptureBound::Depth where the route would run past the declared nesting magnitude. The step refuses rather than saturating, because a saturated depth makes two different tokens share one route.

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

The route’s steps, from the root inward.

pub fn depth(&self) -> usize

How deep this route runs; the root is zero.

pub fn is_root(&self) -> bool

Whether this route names the declared input itself.

Trait Implementations

impl Clone for TokenPath

fn clone(&self) -> TokenPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenPath

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

Formats the value using the given formatter.

impl Eq for TokenPath

impl Hash for TokenPath

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 TokenPath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TokenPath