Struct Quality

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

Quality level of the brotli compression

Quality::best() represents the best available quality that maximizes the compression ratio at the cost of run-time speed. Quality::worst() represents the worst available quality that maximizes speed at the expense of compression ratio.

Implementations

impl Quality

pub const fn new(level: u8) -> Result<Quality, SetParameterError>

Attempts to create a new brotli compression quality.

The range of valid qualities is from 0 to 11 inclusive, where 0 is the worst possible quality and 11 is the best possible quality.

Errors

An Err will be returned if the level is out of the range of valid qualities.

Examples

use brotlic::Quality;

let worst_quality = Quality::new(0)?;
let best_quality = Quality::new(11)?;

assert_eq!(worst_quality, Quality::worst());
assert_eq!(best_quality, Quality::best());

pub const unsafe fn new_unchecked(level: u8) -> Quality

Creates a new brotli compression quality without checking whether the integer represents a valid quality. The range of valid qualities is from 0 to 11 inclusive, where 0 is the worst possible quality and 11 is the best possible quality. Using any level outside of this range will result in undefined behaviour.

Safety

The level must be between 0 and 11.

Examples

use brotlic::Quality;

// SAFETY: 5 is within the range of valid qualities from 0 to 11
let quality = unsafe { Quality::new_unchecked(5) };

assert_eq!(quality.level(), 5);

pub const fn best() -> Quality

The highest quality for brotli compression.

This quality yields maximum compression ratio at the expense of run-time speed. It’s currently set to 11.

Examples

use brotlic::Quality;

let best_quality = Quality::new(11)?;

assert_eq!(best_quality, Quality::best());

pub const fn default() -> Quality

The default quality to use for brotli compression.

This is set to the best possible quality 11.

Examples

use brotlic::Quality;

let default_quality = Quality::new(11)?;

assert_eq!(default_quality, Quality::default());

pub const fn worst() -> Quality

The worst quality to use for brotli compression.

This quality yields the worst compression ratio while offering the highest run-time speed. It’s currently set to 0.

Examples

use brotlic::Quality;

let worst_quality = Quality::new(0)?;

assert_eq!(worst_quality, Quality::worst());

pub const fn level(&self) -> u8

Returns an integer representing the quality level.

Examples

use brotlic::Quality;

let quality = Quality::new(4)?;

assert_eq!(quality.level(), 4);

Trait Implementations

impl Clone for Quality

fn clone(&self) -> Quality

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quality

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

Formats the value using the given formatter.

impl Default for Quality

fn default() -> Quality

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

impl Ord for Quality

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

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

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

impl Eq for Quality

impl StructuralPartialEq for Quality