Struct DepthLimit 

pub struct DepthLimit(/* private fields */);

A checked finite traversal depth or an explicitly unlimited traversal. The root has depth zero. Unlimited depth retains entry and byte budgets. Finite depths 0 through 65,533 are representable; larger values are rejected. Both this type and Option<DepthLimit> occupy two bytes.

Implementations

impl DepthLimit

pub const fn new(depth: usize) -> Option<DepthLimit>

Construct a finite limit. Out-of-range input never disables the limit.

pub const fn unlimited() -> DepthLimit

Disable the depth limit while retaining other traversal budgets.

pub const fn get(self) -> usize

Effective finite limit, or usize::MAX for unlimited traversal.

pub const fn is_unlimited(self) -> bool

Trait Implementations

impl Clone for DepthLimit

fn clone(&self) -> DepthLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DepthLimit

impl Debug for DepthLimit

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

Formats the value using the given formatter.

impl Default for DepthLimit

fn default() -> DepthLimit

Returns the “default value” for a type.

impl Eq for DepthLimit

impl PartialEq for DepthLimit

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DepthLimit