我可以创建自己的条件编译属性吗

Question

在我的机箱中有几种方法，有些可以快速执行，有些可以降低二进制大小，有些还有其他优点，所以我为所有这些方法提供了用户界面。编译器将优化掉未使用的函数。机箱中的内部函数也必须使用这些接口，我希望它们在编译时尊重用户的选择。

有像target_os这样的条件编译属性，它们存储像linux或windows这样的值。我如何创建这样一个属性，例如prefer_method，以便我和用户可以像在下面的代码片段中一样使用它？

我的板条箱：

#[cfg(not(any(
not(prefer_method),
prefer_method = "fast",
prefer_method = "small"
)))]
compile_error("invalid `prefer_method` value");
pub fn bla() {
#[cfg(prefer_method = "fast")]
foo_fast();
#[cfg(prefer_method = "small")]
foo_small();
#[cfg(not(prefer_method))]
foo_default();
}
pub fn foo_fast() {
// Fast execution.
}
pub fn foo_small() {
// Small binary file.
}
pub fn foo_default() {
// Medium size, medium fast.
}

用户机箱：

#[prefer_method = "small"]
extern crate my_crate;
fn f() {
// Uses the `foo_small` function, the other `foo_*` functions will not end up in the binary.
my_crate::bla();
// But the user can also call any function, which of course will also end up in the binary.
my_crate::foo_default();
}

我知道有--cfg属性，但AFAIK这些属性只代表布尔标志，而不是枚举值，当只有一个枚举值有效时，可以设置多个标志。

Answer 1

首先，--cfg标志支持使用语法--cfg 'prefer_method="fast"'的键值对。这将允许您编写如下代码：

#[cfg(prefer_method = "fast")]
fn foo_fast() { }

您也可以从构建脚本中设置这些cfg选项。例如：

// build.rs
fn main() {
println!("cargo:rustc-cfg=prefer_method="method_a"");
}

// src/main.rs
#[cfg(prefer_method = "method_a")]
fn main() {
println!("It's A");
}
#[cfg(prefer_method = "method_b")]
fn main() {
println!("It's B");
}
#[cfg(not(any(prefer_method = "method_a", prefer_method = "method_b")))]
fn main() {
println!("No preferred method");
}

上面的代码将生成一个可执行文件，打印"It’s A"。

没有像您建议的指定cfg设置那样的语法。向板条箱用户展示这些选项的最佳方式是通过Cargo功能。

例如：

# Library Cargo.toml
# ...
[features]
method_a = []
method_b = []

// build.rs
fn main() {
// prefer method A if both method A and B are selected
if cfg!(feature = "method_a") {
println!("cargo:rustc-cfg=prefer_method="method_a"");
} else if cfg!(feature = "method_b") {
println!("cargo:rustc-cfg=prefer_method="method_b"");
}
}

# User Cargo.toml
# ...
[dependencies.my_crate]
version = "..."
features = ["method_a"]

然而，在这种情况下，我建议直接在代码中使用Cargo功能(即#[cfg(feature = "fast")](，而不是添加构建脚本，因为Cargo功能和正在添加的rustcfg之间存在一一对应关系。