Struct mz_ore::stack::RecursionGuard

pub struct RecursionGuard {
    depth: RefCell<usize>,
    limit: usize,
}

Available on crate feature stack only.

Tracks recursion depth.

See the CheckedRecursion trait for usage instructions.

Fields

depth: RefCell<usize>

limit: usize

Implementations

impl RecursionGuard

pub fn with_limit(limit: usize) -> RecursionGuard

Constructs a new recursion guard with the specified recursion limit.

fn descend(&self) -> Result<(), RecursionLimitError>

fn ascend(&self)

Trait Implementations

impl CheckedRecursion for RecursionGuard

fn recursion_guard(&self) -> &RecursionGuard

Extracts a reference to the recursion guard embedded within the type.

fn checked_recur<F, T, E>(&self, f: F) -> Result<T, E>

where F: FnOnce(&Self) -> Result<T, E>, E: From<RecursionLimitError>,

Checks whether it is safe to recur and calls f if so.

fn checked_recur_mut<F, T, E>(&mut self, f: F) -> Result<T, E>

where F: FnOnce(&mut Self) -> Result<T, E>, E: From<RecursionLimitError>,

Like CheckedRecursion::checked_recur, but operates on a mutable reference to Self.

impl Clone for RecursionGuard

fn clone(&self) -> RecursionGuard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecursionGuard

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

Formats the value using the given formatter.

impl Default for RecursionGuard

fn default() -> RecursionGuard

Returns the “default value” for a type.