Skip to main content

CpuLevel

Enum CpuLevel 

Source
#[non_exhaustive]
pub enum CpuLevel { Scalar, Sse2, Sse42, Bmi2, Avx2, Avx512, Neon, Sve, }
Expand description

The ceiling on the instruction sets the kernels may use: see set_cpu_ceiling. The ceiling on the instruction sets the kernels may use: see set_cpu_ceiling. The ceiling on the instruction sets the kernels may use: see set_cpu_ceiling. An instruction-set level the codec’s kernels may be limited to, from the portable scalar code up. The x86 levels (Sse2 through Avx512) and the aarch64 ones (Neon, Sve) are separate ladders; Scalar sits under both.

Used with set_cpu_ceiling to compare kernel tiers on one machine.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Scalar

Portable code only.

§

Sse2

x86 SSE2.

§

Sse42

x86 SSE4.2.

§

Bmi2

x86 BMI2, with everything below it.

§

Avx2

x86 AVX2 (and BMI2), the x86-64-v3 kernels.

§

Avx512

x86 AVX-512 (the VBMI2 kernels, when built with kernel-vbmi2).

§

Neon

aarch64 NEON.

§

Sve

aarch64 SVE and SVE2.

Implementations§

Source§

impl CpuLevel

Source

pub const ALL: [CpuLevel; 8]

Every level, lowest first within each ladder.

Source

pub const fn name(self) -> &'static str

The level’s name as FromStr reads it.

§Examples
use structured_zstd::CpuLevel;

assert_eq!(CpuLevel::Sse42.name(), "sse4.2");
assert_eq!("avx2".parse::<CpuLevel>(), Ok(CpuLevel::Avx2));

Trait Implementations§

Source§

impl Clone for CpuLevel

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CpuLevel

Source§

impl Debug for CpuLevel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for CpuLevel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CpuLevel

Source§

impl FromStr for CpuLevel

Source§

fn from_str(text: &str) -> Result<Self, Self::Err>

The names CpuLevel::name gives, case-insensitive, plus the spellings sse42, avx-512 and avx512f.

Source§

type Err = UnknownCpuLevel

The associated error which can be returned from parsing.
Source§

impl Hash for CpuLevel

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CpuLevel

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CpuLevel

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.