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 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 Iterator<Item = &str> + ExactSizeIterator

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