Struct PlatformSummary 

#[non_exhaustive]
pub struct PlatformSummary {
    pub triple: String,
    pub custom_json: Option<String>,
    pub custom_cfg: Option<String>,
    pub target_features: TargetFeaturesSummary,
    pub flags: BTreeSet<String>,
}

Available on crate feature summaries only.

An owned, serializable version of Platform.

This structure can be serialized and deserialized using serde.

Requires the summaries feature to be enabled.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

triple: String

The platform triple.

custom_json: Option<String>

JSON for custom platforms.

custom_cfg: Option<String>

rustc --print=cfg output for custom platforms.

target_features: TargetFeaturesSummary

The target features used.

flags: BTreeSet<String>

The flags enabled.

Implementations

impl PlatformSummary

pub fn new(triple_str: impl Into<String>) -> Self

Creates a new PlatformSummary with the provided triple and default options.

The default options are:

• custom_json is set to None.
• custom_cfg is set to None.
• target_features is set to TargetFeaturesSummary::Unknown.
• flags is empty.

pub fn with_custom_json(self, custom_json: impl Into<String>) -> Self

If this represents a custom platform, sets the target definition JSON for it.

This clears any previously set custom_cfg, since only one custom platform source is allowed.

For more about target definition JSON, see Creating a custom target in the Rust Embedonomicon.

pub fn with_custom_cfg(self, custom_cfg: impl Into<String>) -> Self

If this represents a custom platform created from rustc --print=cfg output, sets that output.

This clears any previously set custom_json, since only one custom platform source is allowed.

pub fn with_target_features( self, target_features: TargetFeaturesSummary, ) -> Self

Sets the target features for this platform.

pub fn with_added_flags( self, flags: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Adds flags for this platform.

pub fn from_platform(platform: &Platform) -> Self

Creates a new PlatformSummary instance from a platform.

pub fn to_platform(&self) -> Result<Platform, Error>

Converts self to a Platform.

Returns an Error if the platform was unknown.

Trait Implementations

impl Clone for PlatformSummary

fn clone(&self) -> PlatformSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlatformSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlatformSummary

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PlatformSummary

fn eq(&self, other: &PlatformSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PlatformSummary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PlatformSummary

impl StructuralPartialEq for PlatformSummary