Struct TargetFeatures 

pub struct TargetFeatures { /* private fields */ }

A set of target features.

Implementations

impl TargetFeatures

pub const fn suggested_simd_width<T: SimdElement>(&self) -> Option<usize>

Returns a suggested number of elements for a SIMD vector of type T.

The returned value is an approximation and not necessarily indicative of the optimal vector width. A few caveats:

• Every instruction set is different, and this function doesn’t take into account any particular operations–it’s just a guess, and should be accurate at least for basic arithmetic.
• Variable-length vector instruction sets (ARM SVE and RISC-V V) only return the minimum vector length.

impl TargetFeatures

pub const fn empty() -> Self

Returns a set containing no target features.

pub const fn enabled_for_target() -> Self

Returns the target features enabled at compile time.

This includes features enabled by the target specification, target CPU, and -C target-feature compiler options.

pub const fn contains(self, required: Self) -> bool

Returns whether self contains every target feature in required.

Examples found in repository

examples/proof-token.rs (line 76)

fn safe_avx_fn<P: Proof>(_: P) {
    #[target_feature(enable = "avx")]
    unsafe fn unsafe_avx_fn() {
        println!("called an avx function")
    }

    // Future improvements to const generics might make it possible to assert this at compile time.
    // Since P::TARGET is const, this assert disappears if the required features are present.
    assert!(
        P::TARGET.contains(target_features::x86_64::AVX),
        "avx feature not supported"
    );
    unsafe { unsafe_avx_fn() }
}

pub const fn with(self, additional: Self) -> Self

Returns self with all target features in additional.

Trait Implementations

impl Clone for TargetFeatures

fn clone(&self) -> TargetFeatures

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TargetFeatures

impl Debug for TargetFeatures

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

Formats the value using the given formatter.

impl Eq for TargetFeatures

impl Hash for TargetFeatures

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TargetFeatures

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TargetFeatures