third_party_rust_cfg-if/README.md

48 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2015-07-08 01:07:04 +00:00
# cfg-if
2018-04-23 18:44:25 +00:00
[Documentation](https://docs.rs/cfg-if)
2015-07-08 01:07:04 +00:00
A macro to ergonomically define an item depending on a large number of #[cfg]
parameters. Structured like an if-else chain, the first matching branch is the
item that gets emitted.
```toml
[dependencies]
cfg-if = "0.1"
```
## Example
```rust
2019-06-21 16:45:26 +00:00
cfg_if::cfg_if! {
2015-07-08 01:07:04 +00:00
if #[cfg(unix)] {
fn foo() { /* unix specific functionality */ }
} else if #[cfg(target_pointer_width = "32")] {
fn foo() { /* non-unix, 32-bit functionality */ }
} else {
fn foo() { /* fallback implementation */ }
}
}
2015-07-08 01:09:13 +00:00
fn main() {
foo();
}
2015-07-08 01:07:04 +00:00
```
# License
This project is licensed under either of
2015-07-08 01:07:04 +00:00
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
2015-07-08 01:07:04 +00:00
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `cfg-if` by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.