Struct target_spec::Triple

pub struct Triple { /* private fields */ }

A single, specific target, uniquely identified by a triple.

A Triple may be constructed through new or the FromStr implementation.

Every Platform is backed by one of these.

Standard and custom platforms

target-spec recognizes two kinds of platforms:

• Standard platforms: These platforms are only specified by their triple string, either directly or via a Triple. For example, the platform x86_64-unknown-linux-gnu is a standard platform since it is recognized by Rust.

  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.

Examples

use target_spec::Triple;

// Parse a simple target.
let target = Triple::new("x86_64-unknown-linux-gnu").unwrap();
// This is not a valid triple.
let err = Triple::new("cannot-be-known").unwrap_err();

Implementations

impl Triple

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

Creates a new Triple from a triple string.

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

Creates a new Triple from a triple string.

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 new_custom( triple_str: impl Into<Cow<'static, str>>, json: &str ) -> Result<Self, CustomTripleCreateError>

Available on crate feature custom only.

Creates a new custom Triple from the given triple string and JSON specification.

pub fn as_str(&self) -> &str

Returns the string corresponding to this triple.

pub fn is_standard(&self) -> bool

Returns true if this is a triple corresponding to a standard platform.

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

Examples

use target_spec::Triple;

// x86_64-unknown-linux-gnu is Linux x86_64.
let platform = Triple::new("x86_64-unknown-linux-gnu").unwrap();
assert!(platform.is_standard());

pub fn is_builtin(&self) -> bool

Returns true if this is a triple corresponding to a builtin platform.

Examples

use target_spec::Triple;

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

pub fn is_heuristic(&self) -> bool

Returns true if this triple was heuristically determined.

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

Examples

use target_spec::Triple;

// armv5te-apple-darwin is not a real platform, but target-spec can heuristically
// guess at its characteristics.
let triple = Triple::new("armv5te-apple-darwin").unwrap();
assert!(triple.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 eval(&self, platform: &Platform) -> bool

Evaluates this triple against the given platform.

This simply compares self’s string representation against the Triple the platform is based on, ignoring target features and flags.

Trait Implementations

impl Clone for Triple

fn clone(&self) -> Triple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Triple

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

Formats the value using the given formatter.

impl FromStr for Triple

type Err = TripleParseError

The associated error which can be returned from parsing.

fn from_str(triple_str: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Triple

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 Triple

fn cmp(&self, other: &Triple) -> 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 Triple

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

fn partial_cmp(&self, other: &Triple) -> 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 Triple

impl StructuralPartialEq for Triple