Struct BlockSize

pub struct BlockSize(/* private fields */);

The recommended input block size (in bits) to use for compression.

The compressor may reduce this value at its leisure, for example when the input size is small. Larger block sizes allow better compression at the expense of using more memory. Rough formula for memory required is 3 << bits bytes.

Implementations

impl BlockSize

pub const fn new(bits: u8) -> Result<BlockSize, SetParameterError>

Constructs a new block size (in bits) to use for brotli compression.

Valid bits range from 16 to 24 inclusive.

Errors

An Err will be returned if the bits are out of the range of valid block sizes.

Examples

use brotlic::BlockSize;

let worst_size = BlockSize::new(16)?;
let best_size = BlockSize::new(24)?;

assert_eq!(worst_size, BlockSize::worst());
assert_eq!(best_size, BlockSize::best());

pub const fn new_unchecked(bits: u8) -> BlockSize

Constructs a new block size (in bits) to use for brotli compression.

Valid bits range from 16 to 24 inclusive. Using any number of bits outside of that range results in undefined behaviour.

Safety

The number of bits must be between 16 and 24.

Examples

use brotlic::BlockSize;

let block_size = unsafe { BlockSize::new_unchecked(22) };

assert_eq!(block_size.bits(), 22);

pub const fn best() -> BlockSize

Constructs the best block size (in bits) to use for brotli compression.

This will allow better compression at the expense of memory usage. Currently it is set to 24 bits.

Examples

use brotlic::BlockSize;

let best_size = BlockSize::new(24)?;

assert_eq!(best_size, BlockSize::best());

pub const fn worst() -> BlockSize

Constructs the worst block size (in bits) to use for brotli compression.

This will consume the least amount of memory at the expense of compression ratio. Currently it is set to 16 bits.

Examples

use brotlic::BlockSize;

let worst_size = BlockSize::new(16)?;

assert_eq!(worst_size, BlockSize::worst());

pub const fn bits(&self) -> u8

Returns an integer representing the block size in bits.

Examples

use brotlic::BlockSize;

let block_size = BlockSize::new(23)?;

assert_eq!(block_size.bits(), 23);

Trait Implementations

impl Clone for BlockSize

fn clone(&self) -> BlockSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockSize

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

Formats the value using the given formatter.

impl Ord for BlockSize

fn cmp(&self, other: &BlockSize) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BlockSize

fn eq(&self, other: &BlockSize) -> 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 PartialOrd for BlockSize

fn partial_cmp(&self, other: &BlockSize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for BlockSize

impl Eq for BlockSize

impl StructuralPartialEq for BlockSize