Struct CpuFeatures 

pub struct CpuFeatures {
    pub avx2: bool,
    pub neon: bool,
    pub forced_scalar: bool,
}

Snapshot of the host CPU features detect_features cares about.

The struct is intentionally small and Copy: it is read on the hot path of every distance call. New fields will be added in additive releases — match on it exhaustively at your own risk.

The forced_scalar field reflects the value of the override at the moment detect_features returned. Do not cache a CpuFeatures across a force_scalar call: call detect_features each time you need a fresh view.

Examples

let features = iqdb_distance::detect_features();
// Repeated calls return the same value (snapshot is cached).
assert_eq!(features, iqdb_distance::detect_features());

Fields

avx2: bool

True if the host advertises AVX2 (x86_64 only). Always false on other architectures.

neon: bool

True if the host advertises NEON (aarch64 only). Always false on other architectures.

forced_scalar: bool

True if force_scalar has been called in this process. Once set, the flag is read on every dispatch — see the force_scalar docs.

Trait Implementations

impl Clone for CpuFeatures

fn clone(&self) -> CpuFeatures

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CpuFeatures

impl Debug for CpuFeatures

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

Formats the value using the given formatter.

impl Eq for CpuFeatures

impl PartialEq for CpuFeatures

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