Struct noodles_bgzf::writer::CompressionLevel

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

A DEFLATE compression level.

Implementations

impl CompressionLevel

pub const NONE: Self = _

No compression.

pub const FAST: Self = _

A compression level optimized for speed.

pub const BEST: Self = _

A compression level optimized for compression rate.

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

Creates a compression level.

Examples

use noodles_bgzf::writer::CompressionLevel;
assert_eq!(CompressionLevel::new(0), Some(CompressionLevel::NONE));
assert!(CompressionLevel::new(255).is_none());

pub const fn get(&self) -> u8

Returns the inner value.

Examples

use noodles_bgzf::writer::CompressionLevel;
assert_eq!(CompressionLevel::NONE.get(), 0);

pub fn none() -> Self

👎Deprecated since 0.29.0: Use CompressionLevel::NONE instead.

Returns a compression level to disable compression.

Examples

use noodles_bgzf::writer::CompressionLevel;
let compression_level = CompressionLevel::none();

pub fn fast() -> Self

👎Deprecated since 0.29.0: Use CompressionLevel::FAST instead.

Returns a compression level optimized for speed.

Examples

use noodles_bgzf::writer::CompressionLevel;
let compression_level = CompressionLevel::fast();

pub fn best() -> Self

👎Deprecated since 0.29.0: Use CompressionLevel::BEST instead.

Returns a compression level optimized for compression rate.

Examples

use noodles_bgzf::writer::CompressionLevel;
let compression_level = CompressionLevel::best();

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

Returns the “default value” for a type.

impl From<CompressionLevel> for Compression

fn from(compression_level: CompressionLevel) -> Self

Converts to this type from the input type.

impl From<CompressionLevel> for u8

fn from(compression_level: 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

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 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

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<u8> for CompressionLevel

type Error = TryFromU8Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for CompressionLevel

impl Eq for CompressionLevel

impl StructuralPartialEq for CompressionLevel