如何激活所有 crate 中的功能？

Question

我想有条件地启用运行时检查和日志记录，它们相互独立，也不受调试和发布模式的影响。所以我开始在我的项目中添加两个features，一个叫做“invariant-checking”，一个叫做“logging”。最终，我希望通过我在项目范围内可见的 crate 中定义的宏来使用它们。

我曾假设，如果我在所有 crate 中以相同方式填写 features section，那么当我在编译 bin crate 时激活该功能时，所有 lib crate 也会启用该功能，但这种情况并非如此！如何跨多个 crate 启用和禁用功能？希望这可以通过仅更改一件事来完成，例如 cargo 的命令行参数。

为了明确我想要什么，here's an example，我还将在下面复制：

共有三个 crate，分别是 main、bin、crate 和两个 lib crate，分别称为“middle”和“common”。以下是相关文件的相关部分：

main.rs

extern crate common;
extern crate middle;

fn main() {
    common::check!();

    middle::run();

    println!("done");
}

主要的Cargo.toml

[dependencies]

[dependencies.common]
path = "libs/common"

[dependencies.middle]
path = "libs/middle"

[features]
default = []
invariant-checking = []
logging = []

中间的lib.rs

extern crate common;

pub fn run() {
    common::check!();

    common::run();
}

中间的Cargo.toml

[dependencies]

[dependencies.common]
path = "../common"

[features]
default = []
invariant-checking = []
logging = []

common 的 lib.rs

#[macro_export]
macro_rules! check {
    () => {{
        if cfg!(feature = "invariant-checking") {
            println!("invariant-checking {}:{}", file!(), line!());
        }
        if cfg!(feature = "logging") {
            println!("logging {}:{}", file!(), line!());
        }
    }};
}

pub fn run() {
    check!()
}

最后是common的Cargo.toml

[dependencies]

[features]
default = []
invariant-checking = []
logging = []

当我运行cargo run --features "invariant-checking,logging" 时，我得到以下输出

invariant-checking src\main.rs:5
logging src\main.rs:5
done

但也希望它登录中间和普通。我怎样才能改变这个项目，使它能够做到这一点，并且仍然允许我只通过改变一个地方来获得“完成”作为输出？

Answer 1

如何跨多个 crate 启用和禁用功能？

Cargo.toml 可以添加可传递地启用其他允许属于依赖项的功能的功能。

例如，在依赖于 crate foo 和 bar 的 crate 的 Cargo.toml 中：

[dependencies]
foo = "0.1"
bar = "0.1"

[features]
default = []
invariant-checking = [ "foo/invariant-checking", "bar/invariant-checking" ]
logging = [ "foo/logging", "bar/logging" ]

此板条箱添加了 invariant-checking 和 logging 功能。启用它们可传递地启用板条箱foo 和bar 的各自功能，以便

cargo build --features=logging,invariant-checking

将在此 crate 及其依赖项 foo 和 bar 中启用 logging 和 invariant-checking 功能。

在您的特定情况下，您可能希望main 可传递地启用middle 和common 的功能，而middle 可传递地启用common 的功能。

Answer 2

当前形式的宏定义存在一个问题：每当使用宏时，宏内部的代码都会被内联，然后在它被内联的上下文中编译。由于您使用运行时功能检查，例如

if cfg!(feature = "invariant-checking")

这意味着您需要在使用宏的每个 crate 中定义功能。另一方面，在 common crate 本身中，该功能永远不会被查询，因此是多余的。

这对我来说似乎完全倒退了。特性标志应该只在公共 crate 中查询，并且使用宏不需要首先在使用它的 crate 中定义特性标志。出于这个原因，我建议使用编译时检查来选择要定义的宏：

#[cfg(feature = "invariant-checking")]
macro_rules! check_invariant {
    () => ( println!("invariant-checking {}:{}", file!(), line!()); )
}

#[cfg(not(feature = "invariant-checking"))]
macro_rules! check_invariant {
    () => ()
}

#[cfg(feature = "logging")]
macro_rules! logging {
    () => ( println!("logging {}:{}", file!(), line!()); )
}

#[cfg(not(feature = "logging"))]
macro_rules! logging {
    () => ()
}

#[macro_export]
macro_rules! check {
    () => ( check_invariant!(); logging!(); )
}

这样，您只需要在common crate 中定义该功能即可。只要您只使用该 crate 的单个版本，打开和关闭标志就会具有全局效果。