Struct BrotliDecoderOptions

pub struct BrotliDecoderOptions { /* private fields */ }

Decompression options to be used for a BrotliDecoder.

Examples

Building an decoder that supports large window sizes:

use brotlic::BrotliDecoderOptions;

let encoder = BrotliDecoderOptions::new().large_window_size(true).build();

Implementations

impl BrotliDecoderOptions

pub fn new() -> Self

Creates a new blank set decoder options.

initially no modifications are applied to the decoder and everything is set to its default values.

pub fn disable_ring_buffer_reallocation( &mut self, disable_ring_buffer_reallocation: bool, ) -> &mut Self

Disable “canny” ring buffer allocation strategy.

Ring buffer is allocated according to window size, despite the real size of the content.

pub fn large_window_size(&mut self, large_window_size: bool) -> &mut Self

Flag that determines if this decoder supports non standard large window sizes. By default, this is turned off and window sizes are limited by RFC7932 (Brotli proper). To support large window sizes outside of the specification, this flag must be enabled. For more information see LargeWindowSize.

pub fn build(&self) -> Result<BrotliDecoder, SetParameterError>

Creates a brotli decoder using the specified settings.

Errors

If any of the preconditions of the parameters are violated, an error is returned.

Trait Implementations

impl Clone for BrotliDecoderOptions

fn clone(&self) -> BrotliDecoderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrotliDecoderOptions

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

Formats the value using the given formatter.

impl Default for BrotliDecoderOptions

fn default() -> Self

Returns the “default value” for a type.