Struct target_features::Target

pub struct Target { /* private fields */ }

A target architecture with optional features.

Implementations

impl Target

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

Returns a suggested number of elements for a SIMD vector of the provided type.

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 Target

pub const fn new(architecture: Architecture) -> Self

Create a target with no specified features.

pub const fn from_cpu( architecture: Architecture, cpu: &str ) -> Result<Self, UnknownCpu>

Create a target based on a particular CPU.

pub const fn architecture(&self) -> Architecture

Returns the target architecture.

pub const fn features(&self) -> FeaturesIter

Returns an iterator over the features.

pub const fn supports_feature(&self, feature: Feature) -> bool

Returns whether the target supports the specified feature.

pub const fn supports_feature_str(&self, feature: &str) -> bool

Returns whether the target supports the specified feature.

Panics

Panics if the feature doesn’t belong to the target architecture.

Examples found in repository

examples/proof-token.rs (line 74)

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.supports_feature_str("avx"),
        "avx feature not supported"
    );
    unsafe { unsafe_avx_fn() }
}

pub const fn with_feature(self, feature: Feature) -> Self

Add a feature to the target.

Panics

Panics if the feature doesn’t belong to the target architecture.

pub const fn with_feature_str(self, feature: &str) -> Self

Add a feature to the target.

Panics

Panics if the requested feature name doesn’t exist for the target architecture.

Trait Implementations

impl Clone for Target

fn clone(&self) -> Target

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Target

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

Formats the value using the given formatter.

impl PartialEq for Target

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Target

impl Eq for Target

impl StructuralPartialEq for Target