cargo-emit 0.2.1

Talk to Cargo easily at build time.
Documentation 
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
83
84
85

<div align="center">
    <a href="https://github.com/nvzqz/cargo-emit">
        <img src="https://raw.githubusercontent.com/nvzqz/cargo-emit/assets/logo.svg?sanitize=true"
             width="300"
             height="300">
    </a>
    <h1>Cargo Emit</h1>
    <a href="https://crates.io/crates/cargo-emit">
        <img src="https://img.shields.io/crates/v/cargo-emit.svg" alt="Crates.io">
        <img src="https://img.shields.io/crates/d/cargo-emit.svg" alt="Downloads">
    </a>
    <a href="https://travis-ci.com/nvzqz/cargo-emit">
        <img src="https://travis-ci.com/nvzqz/cargo-emit.svg?branch=master" alt="Build Status">
    </a>
    <img src="https://img.shields.io/badge/rustc-^1.31.0-blue.svg" alt="rustc ^1.31.0">
    <br>
    <a href="https://www.patreon.com/nvzqz">
        <img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patron!" height="35">
    </a>
    <a href="https://www.paypal.me/nvzqz">
        <img src="https://buymecoffee.intm.org/img/button-paypal-white.png" alt="Buy me a coffee" height="35">
    </a>
    <br><br>
</div>

Talk to Cargo easily at build time, brought to you by [Nikolai Vazquez].

This library provides:

- Convenience macros for communicating with Cargo during the [`build.rs`]
  phrase. Cargo listens to certain [build script outputs] that dictate how
  it should behave.

- An accessible location for seeing what script build outputs are available
  to emit.

- Protection against typos that can be made when printing these formatted
  outputs directly yourself. Mistyping macro names will result in a compile
  failure.

[Nikolai Vazquez]:      https://twitter.com/NikolaiVazquez
[`build.rs`]:           https://doc.rust-lang.org/cargo/reference/build-scripts.html
[build script outputs]: https://doc.rust-lang.org/cargo/reference/build-scripts.html#outputs-of-the-build-script

## Usage

This crate exposes the following macros:

| Macro                                  | Output                                |
|----------------------------------------|---------------------------------------|
| [`pair!($key, $value)`]                | `cargo:$key=$value`                   |
| [`rerun_if_changed!($path)`]           | `cargo:rerun-if-changed=$path`        |
| [`rerun_if_env_changed!($key)`]        | `cargo:rerun-if-env-changed=$key`     |
| [`rustc_cdylib_link_arg!($flag)`]      | `cargo:rustc-cdylib-link-arg=$flag`   |
| [`rustc_cfg!($feature)`]               | `cargo:rustc-cfg=$feature`            |
| [`rustc_env!($key, $value)`]           | `cargo:rustc-env=$key=$value`         |
| [`rustc_flags!($flags)`]               | `cargo:rustc-flags=$flags`            |
| [`rustc_link_arg!($arg)`]              | `cargo:rustc-link-arg=$arg`           |
| [`rustc_link_arg_bin!($bin => $arg)`]  | `cargo:rustc-link-arg-bin=$bin=$arg`  |
| [`rustc_link_arg_bins!($arg)`]         | `cargo:rustc-link-arg-bins=$arg`      |
| [`rustc_link_lib!($name => $kind)`]    | `cargo:rustc-link-lib=$kind=$name`    |
| [`rustc_link_search!($path => $kind)`] | `cargo:rustc-link-search=$kind=$path` |
| [`warning!($message)`]                 | `cargo:warning=$message`              |

[`pair!($key, $value)`]:                  https://docs.rs/cargo-emit/latest/cargo_emit/macro.pair.html
[`rerun_if_changed!($path)`]:      https://docs.rs/cargo-emit/latest/cargo_emit/macro.rerun_if_changed.html
[`rerun_if_env_changed!($key)`]:  https://docs.rs/cargo-emit/latest/cargo_emit/macro.rerun_if_env_changed.html
[`rustc_cdylib_link_arg!($flag)`]: https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_cdylib_link_arg.html
[`rustc_cfg!($feature)`]:             https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_cfg.html
[`rustc_env!($key, $value)`]:             https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_env.html
[`rustc_flags!($flags)`]:           https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_flags.html
[`rustc_link_arg!($arg)`]:        https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_link_arg.html
[`rustc_link_arg_bin!($bin => $arg)`]:    https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_link_arg_bin.html
[`rustc_link_arg_bins!($arg)`]:   https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_link_arg_bins.html
[`rustc_link_lib!($name => $kind)`]:        https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_link_lib.html
[`rustc_link_search!($path => $kind)`]:     https://docs.rs/cargo-emit/latest/cargo_emit/macro.rustc_link_search.html
[`warning!($message)`]:               https://docs.rs/cargo-emit/latest/cargo_emit/macro.warning.html

## License

This project is released under either:

- [MIT License](https://github.com/nvzqz/cargo-emit/blob/master/LICENSE-MIT)

- [Apache License (Version 2.0)](https://github.com/nvzqz/cargo-emit/blob/master/LICENSE-APACHE)