Struct CaptureWalk 

pub struct CaptureWalk { /* private fields */ }

The running state of one capture walk: what the walk has spent, and how much of the whole-tree magnitude it has taken.

The two are charged separately, because a producer that reads material it discards — a frontend skipping trivia, a reader backtracking over an alternative — spends work the result never shows, and the budget is the only magnitude that can see it.

Implementations

impl CaptureWalk

pub const fn declared() -> Self

A fresh walk, holding the whole declared budget and nothing taken.

pub fn examined(&mut self) -> Result<(), CaptureBound>

Spend one unit of the declared budget on looking at one token.

Errors

Returns CaptureBound::Work where the budget is spent.

pub fn took(&mut self) -> Result<(), CaptureBound>

Count one token against the whole-tree magnitude.

Errors

Returns CaptureBound::Tree where the tree outgrows its declared magnitude.

pub const fn taken(self) -> usize

How many tokens the whole tree has taken so far.

pub const fn remaining(self) -> usize

How much of the declared budget is left.

Trait Implementations

impl Clone for CaptureWalk

fn clone(&self) -> CaptureWalk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CaptureWalk

impl Debug for CaptureWalk

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

Formats the value using the given formatter.

impl Eq for CaptureWalk

impl Hash for CaptureWalk

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 CaptureWalk

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaptureWalk