cargo_emit/
rustc_cfg.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
83
84
85
86
/// Tells Cargo to enable a `$feature`.
///
/// This is equivalent to:
///
/// ```
/// println!("cargo:rustc-cfg=$feature");
/// ```
///
/// # Examples
///
/// Useful for conditionally enabling certain code to run.
///
/// ```
/// # struct Cargo;
/// # impl Cargo {
/// #   fn can_bench(&self) -> bool { true }
/// # }
/// # let cargo = Cargo;
/// if cargo.can_bench() {
///     cargo_emit::rustc_cfg!("bench");
/// }
/// ```
///
/// or, in case you want it to emit to a custom stream:
///
/// ```
/// # struct Cargo;
/// # impl Cargo {
/// #   fn can_bench(&self) -> bool { true }
/// # }
/// # let cargo = Cargo;
/// let mut stdout = std::io::stdout();    
/// if cargo.can_bench() {
///     cargo_emit::rustc_cfg!(
///         to: stdout,
///         "bench"
///     );
/// }
/// ```
///
/// Then outside of `build.rs`:
///
/// ```
/// #[cfg(bench)]
/// mod benches {
///     // ...
/// }
/// ```
#[macro_export]
macro_rules! rustc_cfg {
    (to: $stream:expr, $feature:expr $(, $($args:tt)*)?) => {
        $crate::pair!(to: $stream, "rustc-cfg", $feature $(, $($args)+)?);
    };
    ($feature:expr $(, $($args:tt)*)?) => {
        $crate::rustc_cfg!(to: std::io::stdout(), $feature $(, $($args)+)?);
    };
}

#[cfg(test)]
mod tests {
    #[test]
    fn literal() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::rustc_cfg!(
                    to: output,
                    "CFG"
                );
            }),
            @"cargo:rustc-cfg=CFG\n"
        );
    }

    #[test]
    fn formatted() {
        insta::assert_display_snapshot!(
            crate::capture_output(|output| {
                crate::rustc_cfg!(
                    to: output,
                    "{}", "CFG"
                );
            }),
            @"cargo:rustc-cfg=CFG\n"
        );
    }
}