Struct DecodingOptions

pub struct DecodingOptions {
    pub client_offset: Duration,
    pub max_message_size: usize,
    pub max_chunk_count: usize,
    pub max_string_length: usize,
    pub max_byte_string_length: usize,
    pub max_array_length: usize,
    pub decoding_depth_gauge: DepthGauge,
}

General decoding options.

Fields

client_offset: Duration

Time offset between the client and the server, only used by the client when it’s configured to ignore time skew.

max_message_size: usize

Maximum size of a message in bytes. 0 means no limit.

max_chunk_count: usize

Maximum number of chunks. 0 means no limit.

max_string_length: usize

Maximum length in bytes (not chars!) of a string. 0 actually means 0, i.e. no string permitted

max_byte_string_length: usize

Maximum length in bytes of a byte string. 0 actually means 0, i.e. no byte string permitted

max_array_length: usize

Maximum number of array elements. 0 actually means 0, i.e. no array permitted

decoding_depth_gauge: DepthGauge

Decoding depth gauge is used to check for recursion

Implementations

impl DecodingOptions

pub fn minimal() -> Self

This can be useful for decoding extension objects where the payload is not expected to contain a large value.

pub fn test() -> Self

For test only. Having a separate function makes it easier to control calls to DecodingOptions::default().

pub fn depth_lock(&self) -> Result<DepthLock<'_>, Error>

Get a lease on depth, this will fail if max depth is exceeded. Once the lease is dropped, current depth is decremented.

Trait Implementations

impl Clone for DecodingOptions

fn clone(&self) -> DecodingOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodingOptions

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

Formats the value using the given formatter.

impl Default for DecodingOptions

fn default() -> Self

Returns the “default value” for a type.