Struct Config

pub struct Config {
    pub max_len_array: usize,
    pub max_len_bytes: usize,
    pub max_len_text: usize,
    pub max_size_map: usize,
    pub max_nesting: usize,
    pub skip_tags: bool,
    pub check_tags: bool,
}

Config contains various settings which limit resource consumption or enable certain validation options. Please note that the various maximum length/size values apply to an individual element only.

This is mainly to prevent attackers from providing CBOR values whose length is larger than the available memory. In combination the memory consumption can still become large and it is best to limit the incoming bytes to a specific upper bound, e.g. by using std::io::Take.

Fields

max_len_array: usize

Maximum number of array elements

max_len_bytes: usize

Maximum length of a byte string

max_len_text: usize

Maximum length of a string

max_size_map: usize

Maximum number of object fields

max_nesting: usize

Maximum recursion steps when decoder Values

skip_tags: bool

Ignore Tags when decoding Values

check_tags: bool

Validate Value type matches Tag.

Implementations

impl Config

pub fn default() -> Config

Create default configuration with

• max_len_array = 1000
• max_len_bytes = 5 MB
• max_len_text = 5 MB
• max_size_map = 1000
• max_nesting = 16
• skip_tags = false
• check_tags = true

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl PartialEq for Config

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Config

impl StructuralPartialEq for Config