Struct bip_bencode::BDecodeOpt

pub struct BDecodeOpt { /* fields omitted */ }

Stores decoding options for modifying decode behavior.

Methods

impl BDecodeOpt

fn new(
    max_recursion: usize,
    check_key_sort: bool,
    enforce_full_decode: bool
) -> BDecodeOpt

Create a new BDecodeOpt object.

fn max_recursion(&self) -> usize

Maximum limit allowed when decoding bencode.

fn check_key_sort(&self) -> bool

Whether or not an error should be thrown for out of order dictionary keys.

fn enforce_full_decode(&self) -> bool

Whether or not we enforce that the decoded bencode must make up all of the input bytes or not.

It may be useful to disable this if for example, the input bencode is prepended to some payload and you would like to disassociate it. In this case, to find where the rest of the payload starts that wasn't decoded, get the bencode buffer, and call len().

Trait Implementations

impl Copy for BDecodeOpt

impl Clone for BDecodeOpt

fn clone(&self) -> BDecodeOpt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for BDecodeOpt

fn default() -> BDecodeOpt

Returns the "default value" for a type.