Skip to main content

Depth

Struct Depth 

Source
pub struct Depth(/* private fields */);
Expand description

A saturating u32 counter for nesting-depth tracking.

All arithmetic uses saturating semantics: inc() saturates at u32::MAX (effectively unreachable for real documents), and dec() saturates at 0. This prevents underflow when malformed input would otherwise cause it, in line with the project’s fail-fast policy: a stuck-at-zero counter surfaces as an invalid-sequence error downstream rather than a panic.

Implementations§

Source§

impl Depth

Source

pub fn dec(&mut self)

Saturating decrement by one. Calling on a zero value is a no-op.

Source

pub fn get(self) -> u32

Returns the inner u32 value.

Source

pub fn inc(&mut self)

Saturating increment by one. Calling at u32::MAX is a no-op.

Source

pub fn is_positive(self) -> bool

Returns true when the depth is greater than zero.

Source

pub fn is_zero(self) -> bool

Returns true when the depth is zero.

Source

pub fn reset(&mut self)

Resets the depth to zero. Used when a closing scope guarantees the current nesting level returns to the outermost state.

Trait Implementations§

Source§

impl Clone for Depth

Source§

fn clone(&self) -> Depth

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Depth

Source§

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

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

impl Default for Depth

Source§

fn default() -> Depth

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

impl PartialEq for Depth

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Depth

Source§

impl Eq for Depth

Source§

impl StructuralPartialEq for Depth

Auto Trait Implementations§

§

impl Freeze for Depth

§

impl RefUnwindSafe for Depth

§

impl Send for Depth

§

impl Sync for Depth

§

impl Unpin for Depth

§

impl UnsafeUnpin for Depth

§

impl UnwindSafe for Depth

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.