Debian Codegraph @

.cargo/vendor/autocfg/README.md

raw
1 autocfg
2 =======
3
4 [![autocfg crate](https://img.shields.io/crates/v/autocfg.svg)](https://crates.io/crates/autocfg)
5 [![autocfg documentation](https://docs.rs/autocfg/badge.svg)](https://docs.rs/autocfg)
6 ![minimum rustc 1.0](https://img.shields.io/badge/rustc-1.0+-red.svg)
7 ![build status](https://github.com/cuviper/autocfg/workflows/master/badge.svg)
8
9 A Rust library for build scripts to automatically configure code based on
10 compiler support. Code snippets are dynamically tested to see if the `rustc`
11 will accept them, rather than hard-coding specific version support.
12
13
14 ## Usage
15
16 Add this to your `Cargo.toml`:
17
18 ```toml
19 [build-dependencies]
20 autocfg = "1"
21 ```
22
23 Then use it in your `build.rs` script to detect compiler features. For
24 example, to test for 128-bit integer support, it might look like:
25
26 ```rust
27 extern crate autocfg;
28
29 fn main() {
30 let ac = autocfg::new();
31 ac.emit_has_type("i128");
32
33 // (optional) We don't need to rerun for anything external.
34 autocfg::rerun_path("build.rs");
35 }
36 ```
37
38 If the type test succeeds, this will write a `cargo:rustc-cfg=has_i128` line
39 for Cargo, which translates to Rust arguments `--cfg has_i128`. Then in the
40 rest of your Rust code, you can add `#[cfg(has_i128)]` conditions on code that
41 should only be used when the compiler supports it.
42
43
44 ## Release Notes
45
46 - 1.3.0 (2024-05-03)
47
48 - Add `probe_raw` for direct control of the code that will be test-compiled.
49 - Use wrappers when querying the `rustc` version information too.
50
51 - 1.2.0 (2024-03-25)
52
53 - Add `no_std` and `set_no_std` to control the use of `#![no_std]` in probes.
54 - Use `RUSTC_WRAPPER` and `RUSTC_WORKSPACE_WRAPPER` when they are set.
55
56 - 1.1.0 (2022-02-07)
57 - Use `CARGO_ENCODED_RUSTFLAGS` when it is set.
58
59 - 1.0.1 (2020-08-20)
60 - Apply `RUSTFLAGS` for more `--target` scenarios, by @adamreichold.
61
62 - 1.0.0 (2020-01-08)
63 - 🎉 Release 1.0! 🎉 (no breaking changes)
64 - Add `probe_expression` and `emit_expression_cfg` to test arbitrary expressions.
65 - Add `probe_constant` and `emit_constant_cfg` to test arbitrary constant expressions.
66
67 - 0.1.7 (2019-10-20)
68 - Apply `RUSTFLAGS` when probing `$TARGET != $HOST`, mainly for sysroot, by @roblabla.
69
70 - 0.1.6 (2019-08-19)
71 - Add `probe`/`emit_sysroot_crate`, by @leo60228.
72
73 - 0.1.5 (2019-07-16)
74 - Mask some warnings from newer rustc.
75
76 - 0.1.4 (2019-05-22)
77 - Relax `std`/`no_std` probing to a warning instead of an error.
78 - Improve `rustc` bootstrap compatibility.
79
80 - 0.1.3 (2019-05-21)
81 - Auto-detects if `#![no_std]` is needed for the `$TARGET`.
82
83 - 0.1.2 (2019-01-16)
84 - Add `rerun_env(ENV)` to print `cargo:rerun-if-env-changed=ENV`.
85 - Add `rerun_path(PATH)` to print `cargo:rerun-if-changed=PATH`.
86
87
88 ## Minimum Rust version policy
89
90 This crate's minimum supported `rustc` version is `1.0.0`. Compatibility is
91 its entire reason for existence, so this crate will be extremely conservative
92 about raising this requirement. If this is ever deemed necessary, it will be
93 treated as a major breaking change for semver purposes.
94
95
96 ## License
97
98 This project is licensed under either of
99
100 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
101 https://www.apache.org/licenses/LICENSE-2.0)
102 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
103 https://opensource.org/licenses/MIT)
104
105 at your option.