target_spec

Struct Platform

source
pub struct Platform { /* private fields */ }
Expand description

A platform to evaluate target specifications against.

§Standard and custom platforms

target-spec recognizes two kinds of platforms:

  • Standard platforms: These platforms are only specified by their triple string. For example, the platform x86_64-unknown-linux-gnu is a standard platform since it is recognized by Rust as a tier 1 platform.

    All builtin platforms are standard platforms.

    By default, if a platform isn’t builtin, target-spec attempts to heuristically determine the characteristics of the platform based on the triple string. (Use the new_strict constructor to disable this.)

  • Custom platforms: These platforms are specified via both a triple string and a JSON file in the format defined by Rust. Custom platforms are used for targets not recognized by Rust.

Implementations§

source§

impl Platform

source

pub fn new( triple_str: impl Into<Cow<'static, str>>, target_features: TargetFeatures, ) -> Result<Self, Error>

Creates a new standard Platform from the given triple and target features.

Returns an error if this platform wasn’t known to target-spec.

source

pub fn new_strict( triple_str: impl Into<Cow<'static, str>>, target_features: TargetFeatures, ) -> Result<Self, Error>

Creates a new standard Platform from the given triple and target features.

This constructor only consults the builtin platform table, and does not attempt to heuristically determine the platform’s characteristics based on the triple string.

source

pub fn current() -> Result<Self, Error>

Returns the current platform, as detected at build time.

This is currently always a standard platform, and will return an error if the current platform was unknown to this version of target-spec.

§Notes

In the future, this constructor may also support custom platforms. This will not be considered a breaking change.

source

pub fn from_triple(triple: Triple, target_features: TargetFeatures) -> Self

Creates a new standard platform from a Triple and target features.

source

pub fn new_custom( triple_str: impl Into<Cow<'static, str>>, json: &str, target_features: TargetFeatures, ) -> Result<Self, Error>

Available on crate feature custom only.

Creates a new custom Platform from the given triple, platform, and target features.

source

pub fn add_flags( &mut self, flags: impl IntoIterator<Item = impl Into<Cow<'static, str>>>, )

Adds a set of flags to accept.

A flag is a single token like the foo in cfg(not(foo)).

A default cargo build will always evaluate flags to false, but custom wrappers may cause some flags to evaluate to true. For example, as of version 0.6, cargo web build will cause cargo_web to evaluate to true.

source

pub fn triple_str(&self) -> &str

Returns the target triple string for this platform.

source

pub fn flags(&self) -> impl ExactSizeIterator<Item = &str>

Returns the set of flags enabled for this platform.

source

pub fn has_flag(&self, flag: impl AsRef<str>) -> bool

Returns true if this flag was set with add_flags.

source

pub fn is_standard(&self) -> bool

Returns true if this is a standard platform.

A standard platform can be either builtin, or heuristically determined.

§Examples
use target_spec::{Platform, TargetFeatures};

// x86_64-unknown-linux-gnu is Linux x86_64.
let platform = Platform::new("x86_64-unknown-linux-gnu", TargetFeatures::Unknown).unwrap();
assert!(platform.is_standard());
source

pub fn is_builtin(&self) -> bool

Returns true if this is a builtin platform.

All builtin platforms are standard, but not all standard platforms are builtin.

§Examples
use target_spec::{Platform, TargetFeatures};

// x86_64-unknown-linux-gnu is Linux x86_64, which is a Rust tier 1 platform.
let platform = Platform::new("x86_64-unknown-linux-gnu", TargetFeatures::Unknown).unwrap();
assert!(platform.is_builtin());
source

pub fn is_heuristic(&self) -> bool

Returns true if this is a heuristically determined platform.

All heuristically determined platforms are standard, but most of the time, standard platforms are builtin.

§Examples
use target_spec::{Platform, TargetFeatures};

// armv5te-apple-darwin is not a real platform, but target-spec can heuristically
// guess at its characteristics.
let platform = Platform::new("armv5te-apple-darwin", TargetFeatures::Unknown).unwrap();
assert!(platform.is_heuristic());
source

pub fn is_custom(&self) -> bool

Returns true if this is a custom platform.

This is always available, but if the custom feature isn’t turned on this always returns false.

source

pub fn triple(&self) -> &Triple

Returns the underlying Triple.

source

pub fn target_features(&self) -> &TargetFeatures

Returns the set of target features for this platform.

source§

impl Platform

§Helpers for property testing

The methods in this section allow Platform instances to be used in property-based testing scenarios.

Currently, proptest 1 is supported if the proptest1 feature is enabled.

source

pub fn strategy( target_features: impl Strategy<Value = TargetFeatures>, ) -> impl Strategy<Value = Platform>

Available on crate feature proptest1 only.

Given a way to generate TargetFeatures instances, this returns a Strategy that generates a platform at random.

Requires the proptest1 feature to be enabled.

§Examples
use proptest::prelude::*;
use target_spec::{Platform, TargetFeatures};

// target_features is a strategy that always produces TargetFeatures::Unknown.
let target_features = Just(TargetFeatures::Unknown);
let strategy = Platform::strategy(target_features);
source

pub fn filtered_strategy( triple_filter: impl Fn(&'static str) -> bool, target_features: impl Strategy<Value = TargetFeatures>, ) -> impl Strategy<Value = Platform>

Available on crate feature proptest1 only.

A version of strategy that allows target triples to be filtered.

Requires the proptest1 feature to be enabled.

source§

impl Platform

source

pub fn to_summary(&self) -> PlatformSummary

Available on crate feature summaries only.

Converts this Platform to a serializable form.

Requires the summaries feature to be enabled.

Trait Implementations§

source§

impl Clone for Platform

source§

fn clone(&self) -> Platform

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Platform

source§

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

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

impl Hash for Platform

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 Ord for Platform

source§

fn cmp(&self, other: &Platform) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Platform

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 PartialOrd for Platform

source§

fn partial_cmp(&self, other: &Platform) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Platform

source§

impl StructuralPartialEq for Platform

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V