Struct ZstdThreads

pub struct ZstdThreads(u32);

The amount of threads to use when compressing using zstd.

The default (1) adheres to the one selected by the zstd executable. If the custom amount of 0 is used, all available physical CPU cores are used.

Tuple Fields

0: u32

Implementations

impl ZstdThreads

pub fn new(threads: u32) -> Self

Creates a new ZstdThreads from a u32.

pub fn all() -> Self

Creates a new ZstdThreads which uses all physical CPU cores.

This is short for calling ZstdThreads::new with 0.

Trait Implementations

impl Clone for ZstdThreads

fn clone(&self) -> ZstdThreads

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZstdThreads

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

Formats the value using the given formatter.

impl Default for ZstdThreads

fn default() -> Self

Returns the default thread value (1) when compressing with zstd.

The default adheres to the one selected by the zstd executable.

impl Ord for ZstdThreads

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

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

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

impl StructuralPartialEq for ZstdThreads