Struct LargeWindowSize 

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

The large sliding window size (in bits) to use for compression.

Note that using a large sliding window size for a particular compressor requires explicit support by the decompressor. This is supported by enabling large_window_size when constructing a BrotliDecoder.

Implementations

impl LargeWindowSize

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

Constructs a new large sliding window size (in bits) to use for brotli compression.

Valid bits range from 10 (1 KiB) to 30 (1 GiB) inclusive.

Errors

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

Examples

use brotlic::LargeWindowSize;

let worst_size = LargeWindowSize::new(10)?;
let best_size = LargeWindowSize::new(30)?;

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

pub const unsafe fn new_unchecked(bits: u8) -> LargeWindowSize

Constructs a new large sliding window size (in bits) to use for brotli compression.

Valid bits range from 10 (1 KiB) to 30 (1 GiB) inclusive. Using a number of bits outside of that range results in undefined behaviour.

Safety

The number of bits must be between 10 and 30.

Examples

use brotlic::LargeWindowSize;

// SAFETY: 28 is within the valid range of 10 to 30 in large window sizes
let window_size = unsafe { LargeWindowSize::new_unchecked(28) };

assert_eq!(window_size.bits(), 28);

pub const fn best() -> LargeWindowSize

Constructs the best large sliding window size to use for brotli compression.

This is currently set to 30 bits (1 GiB). Note that this requires explicit support by the decompressor. For more information see LargeWindowSize.

Examples

use brotlic::LargeWindowSize;

let best_size = LargeWindowSize::new(30)?;

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

pub const fn default() -> LargeWindowSize

Constructs the default large sliding window size to use for brotli compression.

This is currently set to 22 bits (4 MiB).

Examples

use brotlic::LargeWindowSize;

let default_size = LargeWindowSize::new(22)?;

assert_eq!(default_size, LargeWindowSize::default());

pub const fn worst() -> LargeWindowSize

Constructs the worst large sliding window size to use for brotli compression

This is currently set to 10 bits (1 KiB).

Examples

use brotlic::LargeWindowSize;

let worst_size = LargeWindowSize::new(10)?;

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

pub const fn bits(&self) -> u8

Returns an integer representing the large window size in bits.

Examples

use brotlic::LargeWindowSize;

let window_size = LargeWindowSize::new(28)?;

assert_eq!(window_size.bits(), 28);

Trait Implementations

impl Clone for LargeWindowSize

fn clone(&self) -> LargeWindowSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LargeWindowSize

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

Formats the value using the given formatter.

impl Default for LargeWindowSize

fn default() -> Self

Creates a new LargeWindowSize using default. See its documentation for more.

impl From<WindowSize> for LargeWindowSize

fn from(window_size: WindowSize) -> Self

Constructs a LargeWindowSize from a WindowSize.

This always works because a LargeWindowSize covers a larger range than the regular WindowSize. The inverse is not true, however.

impl Ord for LargeWindowSize

fn cmp(&self, other: &LargeWindowSize) -> 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 LargeWindowSize

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

fn partial_cmp(&self, other: &LargeWindowSize) -> 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 TryFrom<LargeWindowSize> for WindowSize

fn try_from(large_window_size: LargeWindowSize) -> Result<Self, Self::Error>

Attempts to construct a WindowSize from a LargeWindowSize.

This only works if the large window size is currently set to a value lower or equal to WindowSize::best().

Errors

Large window size does not fit into a window size.

type Error = SetParameterError

The type returned in the event of a conversion error.

impl Copy for LargeWindowSize

impl Eq for LargeWindowSize

impl StructuralPartialEq for LargeWindowSize