Struct MemoryConfig 

#[non_exhaustive]
pub struct MemoryConfig { /* private fields */ }

Memory settings for a Deflater: the hash table and the symbol buffer, the two largest parts after the window.

Setting	Default	Memory	Effect
hash bits	window bits + 1, 9 to 15 (12 at most at level 1)	2 bytes per entry	fewer bits: less memory, more collisions, slightly larger output
block symbols	2^(window bits + 1), 1,024 to 16,384	4 bytes per symbol, plus up to 4 bytes of pending output	fewer: less memory, more block headers

Examples

use compress_lib::deflate::MemoryConfig;

let config = MemoryConfig::new().with_hash_bits(11).with_block_symbols(4096);
assert_eq!((config.hash_bits(), config.block_symbols()), (11, 4096));

Implementations

impl MemoryConfig

pub const fn new() -> Self

Both sizes chosen from the window bits.

Examples

assert_eq!(compress_lib::deflate::MemoryConfig::new().hash_bits(), 0);

pub const fn with_hash_bits(self, bits: u8) -> Self

Sets the hash table to 2^bits entries; clamped to 8 to 16 (0 keeps the default).

Examples

assert_eq!(compress_lib::deflate::MemoryConfig::new().with_hash_bits(20).hash_bits(), 16);

pub const fn with_block_symbols(self, symbols: usize) -> Self

Sets the symbols per block; clamped to 256 to 65,536 (0 keeps the default).

Examples

assert_eq!(compress_lib::deflate::MemoryConfig::new().with_block_symbols(100).block_symbols(), 256);

pub const fn hash_bits(&self) -> u8

The hash bits set (0: chosen from the window bits).

Examples

assert_eq!(compress_lib::deflate::MemoryConfig::new().with_hash_bits(10).hash_bits(), 10);

pub const fn block_symbols(&self) -> usize

The symbols per block set (0: chosen from the window bits).

Examples

assert_eq!(compress_lib::deflate::MemoryConfig::new().block_symbols(), 0);

Trait Implementations

impl Clone for MemoryConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemoryConfig

impl Debug for MemoryConfig

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

Formats the value using the given formatter.

impl Default for MemoryConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MemoryConfig

impl Hash for MemoryConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MemoryConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MemoryConfig