cargo_emit/rustc_link_arg.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
/// Tells Cargo to pass the -C link-arg=FLAG option to the compiler,
/// but only when building supported targets (benchmarks, binaries, cdylib crates, examples, and tests).
/// Its usage is highly platform specific.
/// It is useful to set the shared library version or linker script.
///
/// This is equivalent to:
///
/// ```
/// println!("cargo:rustc-link-arg=$flag");
/// ```
///
/// # Examples
///
/// ```
/// let flag1 = // ...
/// # "";
/// let flag2 = // ...
/// # "";
/// cargo_emit::rustc_link_arg!(
/// flag1, flag2
/// );
/// ```
///
/// or, in case you want it to emit to a custom stream:
///
/// ```
/// let flag1 = // ...
/// # "";
/// let flag2 = // ...
/// # "";
/// let mut stdout = std::io::stdout();
/// cargo_emit::rustc_link_arg!(
/// to: stdout,
/// flag1, flag2
/// );
/// ```
#[macro_export]
macro_rules! rustc_link_arg {
(to: $stream:expr, $($flag:expr),+ $(,)?) => {
$($crate::pair!(to: $stream, "rustc-link-arg", "{}", $flag);)+
};
($($flag:expr),+ $(,)?) => {
$crate::rustc_link_arg!(to: std::io::stdout(), $($flag),+);
};
}
#[cfg(test)]
mod tests {
#[test]
fn single() {
insta::assert_display_snapshot!(
crate::capture_output(|output| {
crate::rustc_link_arg!(
to: output,
"ARG"
);
}),
@"cargo:rustc-link-arg=ARG
"
);
}
#[test]
fn multiple() {
insta::assert_display_snapshot!(
crate::capture_output(|output| {
crate::rustc_link_arg!(
to: output,
"ARG1",
"ARG2"
);
}),
@r###"
cargo:rustc-link-arg=ARG1
cargo:rustc-link-arg=ARG2
"###
);
}
}