Struct async_mtzip::level::CompressionLevel

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

Compression level that should be used when compressing a file or data.

Current compression providers support only levels from 0 to 9, so these are the only ones being supported.

Implementations

impl CompressionLevel

pub const fn new(level: u8) -> Option<Self>

Construct a new value of a compression level setting.

The integer value must be less than or equal to 9, otherwise None is returned

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

Construct a new value of a compression level setting without checking the value.

Safety

The value must be a valid supported compression level

pub const fn none() -> Self

No compression

pub const fn fast() -> Self

Fastest compression

pub const fn balanced() -> Self

Balanced level with moderate compression and speed. The raw value is 6.

pub const fn best() -> Self

Best compression ratio, comes at a worse performance

pub const fn get(self) -> u8

Get the compression level as an integer

Trait Implementations

impl Clone for CompressionLevel

fn clone(&self) -> CompressionLevel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompressionLevel

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

Formats the value using the given formatter.

impl Default for CompressionLevel

fn default() -> Self

Equivalent to Self::balanced

impl From<CompressionLevel> for Compression

fn from(value: CompressionLevel) -> Self

Converts to this type from the input type.

impl From<CompressionLevel> for u8

fn from(value: CompressionLevel) -> Self

Converts to this type from the input type.

impl Ord for CompressionLevel

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

Restrict a value to a certain interval.

impl PartialEq for CompressionLevel

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CompressionLevel

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<Compression> for CompressionLevel

type Error = InvalidCompressionLevel

The type returned in the event of a conversion error.

fn try_from(value: Compression) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for CompressionLevel

type Error = InvalidCompressionLevel

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for CompressionLevel

impl Eq for CompressionLevel

impl StructuralPartialEq for CompressionLevel