RecursionGuard

Struct RecursionGuard 

Source
pub struct RecursionGuard { /* private fields */ }
Expand description

Tracks recursion depth during parsing.

This is a lightweight wrapper that parsers use to track and enforce recursion limits. It pairs with ParseConfig to provide the limit.

§Example

struct MyParser {
    depth: RecursionGuard,
    config: ParseConfig,
}

impl MyParser {
    fn parse_nested(&mut self) -> Result<(), Error> {
        self.depth.enter(self.config.max_recursion_depth)?;
        // ... parse nested content ...
        self.depth.exit();
        Ok(())
    }
}

Implementations§

Source§

impl RecursionGuard

Source

pub const fn new() -> Self

Creates a new guard with depth 0.

Source

pub const fn depth(&self) -> usize

Current recursion depth.

Source

pub fn enter(&mut self, limit: usize) -> Result<(), Error>

Enter a nested context, incrementing depth.

Returns Err(Error::RecursionLimitExceeded) if the new depth would exceed the limit.

§Arguments
  • limit - Maximum allowed depth (from ParseConfig::max_recursion_depth)
Source

pub fn exit(&mut self)

Exit a nested context, decrementing depth.

Uses saturating subtraction so extra exit() calls don’t underflow.

Source

pub fn reset(&mut self)

Reset depth to zero.

Useful when reusing a parser for multiple inputs.

Trait Implementations§

Source§

impl Clone for RecursionGuard

Source§

fn clone(&self) -> RecursionGuard

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecursionGuard

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RecursionGuard

Source§

fn default() -> RecursionGuard

Returns the “default value” for a type. Read more
Source§

impl Copy for RecursionGuard

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.