Struct guppy::platform::Platform

pub struct Platform { /* private fields */ }

A platform to evaluate target specs against.

Implementations

impl Platform

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

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

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

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

Returns the current platform, as detected at build time.

This will return an error if the current platform was unknown to this version of target-spec.

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

Creates a new platform from a Triple 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 Iterator<Item = &str> + ExactSizeIterator

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

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>

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

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<(), Error>

Formats the value using the given formatter.

impl Hash for Platform

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

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) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Platform> 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<Platform> 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 StructuralEq for Platform

impl StructuralPartialEq for Platform