Skip to main content

DecodeLimits

Struct DecodeLimits 

Source
pub struct DecodeLimits {
    pub max_input_bytes: usize,
    pub max_depth: usize,
    pub max_total_items: usize,
    pub max_array_len: usize,
    pub max_map_len: usize,
    pub max_bytes_len: usize,
    pub max_text_len: usize,
}
Expand description

Decode-time resource limits for validation and decoding.

Limits are enforced deterministically and must not depend on background timers.

Fields§

§max_input_bytes: usize

Maximum total input length in bytes.

§max_depth: usize

Maximum nesting depth.

§max_total_items: usize

Maximum total count of container items: sum(array_len) + sum(2 * map_pairs) across the entire decoded item (maps count both keys and values).

§max_array_len: usize

Maximum array length.

§max_map_len: usize

Maximum map length (pairs).

§max_bytes_len: usize

Maximum byte-string length (also applies to bignum magnitudes).

§max_text_len: usize

Maximum text-string length in UTF-8 bytes.

Implementations§

Source§

impl DecodeLimits

Source

pub fn for_bytes(max_message_bytes: usize) -> Self

Construct conservative limits derived from a maximum message size.

The defaults are:

  • max_input_bytes = max_message_bytes
  • max_total_items = max_message_bytes
  • max_bytes_len = max_message_bytes
  • max_text_len = max_message_bytes
  • max_array_len and max_map_len are capped by DEFAULT_MAX_CONTAINER_LEN

This is a pragmatic baseline. Production deployments should tune these explicitly.

Trait Implementations§

Source§

impl Clone for DecodeLimits

Source§

fn clone(&self) -> DecodeLimits

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 DecodeLimits

Source§

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

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

impl PartialEq for DecodeLimits

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 DecodeLimits

Source§

impl Eq for DecodeLimits

Source§

impl StructuralPartialEq for DecodeLimits

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> Same for T

Source§

type Output = T

Should always be Self
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.