TargetFeature in rustdoc_json_types - Rust
Description: Information about a target feature.

Skip to main content

## TargetFeature

# Struct TargetFeature

Source

    pub struct TargetFeature {
        pub name: String,
        pub implies_features: Vec<String>,
        pub unstable_feature_gate: Option<String>,
        pub globally_enabled: bool,
    }

Expand description

Information about a target feature.

Rust target features are used to influence code generation, especially around selecting instructions which are not universally supported by the target architecture.

Target features are commonly enabled by the `#[target_feature]` attribute to influence code generation for a particular function, and less commonly enabled by compiler options like `-Ctarget-feature` or `-Ctarget-cpu`. Targets themselves automatically enable certain target features by default, for example because the target’s ABI specification requires saving specific registers which only exist in an architectural extension.

Target features can imply other target features: for example, x86-64 `avx2` implies `avx`, and aarch64 `sve2` implies `sve`, since both of these architectural extensions depend on their predecessors.

Target features can be probed at compile time by `#[cfg(target_feature)]` or `cfg!(…)` conditional compilation to determine whether a target feature is enabled in a particular context.

## Fields§

§`name: String`

The name of this target feature.

§`implies_features: Vec<String>`

Other target features which are implied by this target feature, if any.

§`unstable_feature_gate: Option<String>`

If this target feature is unstable, the name of the associated language feature gate.

§`globally_enabled: bool`

Whether this feature is globally enabled for this compilation session.

Target features can be globally enabled implicitly as a result of the target’s definition. For example, x86-64 hardware floating point ABIs require saving x87 and SSE2 registers, which in turn requires globally enabling the `x87` and `sse2` target features so that the generated machine code conforms to the target’s ABI.

Target features can also be globally enabled explicitly as a result of compiler flags like `-Ctarget-feature` or `-Ctarget-cpu`.

## Trait Implementations§

Source§

### impl Clone for TargetFeature

Source§

#### fn clone(&self) -> TargetFeature

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 Debug for TargetFeature

Source§

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

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

### impl<'de> Deserialize<'de> for TargetFeature

Source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

### impl PartialEq for TargetFeature

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 (const: unstable) · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl Serialize for TargetFeature

Source§

#### fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

### impl Eq for TargetFeature

Source§

### impl StructuralPartialEq for TargetFeature

## Auto Trait Implementations§

§

### impl Freeze for TargetFeature

§

### impl RefUnwindSafe for TargetFeature

§

### impl Send for TargetFeature

§

### impl Sync for TargetFeature

§

### impl Unpin for TargetFeature

§

### impl UnsafeUnpin for TargetFeature

§

### impl UnwindSafe for TargetFeature

## 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

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

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

### impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 80 bytes