target_spec/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// Copyright (c) The cargo-guppy Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

//! Evaluate `Cargo.toml` target specifications against platform triples.
//!
//! Cargo supports [platform-specific
//! dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#platform-specific-dependencies).
//! These dependencies can be specified in one of two ways:
//!
//! ```toml
//! # 1. As Rust-like `#[cfg]` syntax.
//! [target.'cfg(all(unix, target_arch = "x86_64"))'.dependencies]
//! native = { path = "native/x86_64" }
//!
//! # 2. Listing out the full target triple.
//! [target.x86_64-pc-windows-gnu.dependencies]
//! winhttp = "0.4.0"
//! ```
//!
//! `target-spec` provides the `eval` API which can be used to figure out whether such a dependency
//! will be included on a particular platform.
//!
//! ```rust
//! use target_spec::eval;
//!
//! // Evaluate Rust-like `#[cfg]` syntax.
//! let cfg_target = "cfg(all(unix, target_arch = \"x86_64\"))";
//! assert_eq!(eval(cfg_target, "x86_64-unknown-linux-gnu").unwrap(), Some(true));
//! assert_eq!(eval(cfg_target, "i686-unknown-linux-gnu").unwrap(), Some(false));
//! assert_eq!(eval(cfg_target, "x86_64-pc-windows-msvc").unwrap(), Some(false));
//!
//! // Evaluate a full target-triple.
//! assert_eq!(eval("x86_64-unknown-linux-gnu", "x86_64-unknown-linux-gnu").unwrap(), Some(true));
//! assert_eq!(eval("x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc").unwrap(), Some(false));
//! ```
//!
//! For more advanced usage, see [`Platform`] and [`TargetSpec`].
//!
//! ## Optional features
//!
//! * **`custom`**: Adds support for [custom
//!   targets](https://docs.rust-embedded.org/embedonomicon/custom-target.html) via
//!   [`Platform::new_custom`].
//! * **`summaries`**: Adds the [`summaries`] module to enable serialization of [`Platform`] and
//!   [`TargetFeatures`].
//! * **`proptest1`**: Enables support for property-based testing of [`Platform`] and
//!   [`TargetFeatures`] using [`proptest`].
//!
//! ## Minimum supported Rust version
//!
//! The minimum supported Rust version (MSRV) is:
//! * For target-spec 3.0.x: **Rust 1.66**.
//! * For target-spec 3.1.x: **Rust 1.73**.
//!
//! Within the 3.x series, MSRV bumps will be accompanied by a minor version update.
//!
//! ## Related crates
//!
//! To pretty-print target-spec errors, consider using the [miette](https://docs.rs/miette)
//! diagnostic library with [target-spec-miette](https://crates.io/crates/target-spec-miette).

#![warn(missing_docs)]
#![forbid(unsafe_code)]
#![cfg_attr(doc_cfg, feature(doc_cfg, doc_auto_cfg))]

#[cfg(feature = "custom")]
mod custom;
pub mod errors;
mod platform;
#[cfg(feature = "proptest1")]
mod proptest_helpers;
mod simple_eval;
mod spec;
#[cfg(feature = "summaries")]
pub mod summaries;
mod triple;

pub use errors::Error;
pub use platform::*;
pub use simple_eval::*;
pub use spec::*;
pub use triple::*;