Struct WindowSize

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

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

Its maximum size is currently limited to 16 MiB, as specified in RFC7932 (Brotli proper). Larger window sizes are supported via LargeWindowSize, however note that decompression support for these have to be explicitly enabled. This can be configured via large_window_size for the matching BrotliDecoder.

Implementations

impl WindowSize

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

Constructs a new sliding window size to use for brotli compression.

Valid bits range from 10 (1 KiB) to 24 (16 MiB) inclusive.

Errors

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

Examples

use brotlic::WindowSize;

let worst_size = WindowSize::new(10)?;
let best_size = WindowSize::new(24)?;

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

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

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

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

Safety

The number of bits must be between 10 and 24.

Examples

use brotlic::WindowSize;

// SAFETY: 23 is within the valid range of 10 to 24 in window sizes
let window_size = unsafe { WindowSize::new_unchecked(23) };

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

pub const fn best() -> WindowSize

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

This is currently limited to 24 bits (16 MiB) due to RFC7932 (Brotli proper). To use larger sliding window sizes, please refer to LargeWindowSize. Note however that explicit support has to be enabled by the decoder. This is supported by enabling large_window_size when constructing a BrotliDecoder.

Examples

use brotlic::WindowSize;

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

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

pub const fn default() -> WindowSize

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

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

Examples

use brotlic::WindowSize;

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

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

pub const fn worst() -> WindowSize

Constructs the worst sliding window size to use for brotli compression

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

Examples

use brotlic::WindowSize;

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

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

pub const fn bits(&self) -> u8

Returns an integer representing the window size in bits.

Examples

use brotlic::WindowSize;

let window_size = WindowSize::new(24)?;

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

Trait Implementations

impl Clone for WindowSize

fn clone(&self) -> WindowSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowSize

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

Formats the value using the given formatter.

impl Default for WindowSize

fn default() -> WindowSize

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

impl Ord for WindowSize

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

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

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

impl Eq for WindowSize

impl StructuralPartialEq for WindowSize