Struct target_spec::Platform

pub struct Platform { /* private fields */ }

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

impl Platform

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.

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.

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.

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

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

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.

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.

pub fn triple_str(&self) -> &str

Returns the target triple string for this platform.

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

Returns the set of flags enabled for this platform.

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

Returns true if this flag was set with add_flags.

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());

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());

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());

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.

pub fn triple(&self) -> &Triple

Returns the underlying Triple.

pub fn target_features(&self) -> &TargetFeatures

Returns the set of target features for this platform.

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.

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);

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.

impl Platform

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

impl Clone for Platform

fn clone(&self) -> Platform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Platform

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

Formats the value using the given formatter.

impl Hash for Platform

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

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Platform

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Platform

impl StructuralPartialEq for Platform