target_spec

Struct Triple

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

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§

source§

impl Triple

source

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

Creates a new Triple from a triple string.

source

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.

source

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.

source

pub fn as_str(&self) -> &str

Returns the string corresponding to this triple.

source

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

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

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

source§

impl Clone for Triple

source§

fn clone(&self) -> Triple

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 Triple

source§

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

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

impl FromStr for Triple

source§

type Err = TripleParseError

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl Hash for Triple

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 Triple

source§

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

source§

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

source§

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

source§

impl StructuralPartialEq for Triple

Auto Trait Implementations§

§

impl Freeze for Triple

§

impl RefUnwindSafe for Triple

§

impl Send for Triple

§

impl Sync for Triple

§

impl Unpin for Triple

§

impl UnwindSafe for Triple

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