Rust单元测试示例已被调用的方法为何触发死代码警告

触发逻辑 #

该警告来自Rust默认开启的dead_code lint规则，结合cargo test的编译流程，具体成因非常明确：

• cargo test 拆分为两个独立的编译阶段执行：
  • 第一阶段先编译不带测试标识的常规库产物：这一阶段的编译上下文会完全排除所有标记#[cfg(test)]的代码，你编写的整个tests模块在这个阶段根本不会被编译器纳入处理范围。
  • 这一阶段的死代码检查，只会统计当前编译上下文内的实际调用关系：因为tests模块被完全排除，编译器视野里的所有常规代码路径中，can_hold方法没有被任何生产代码调用，因此判定为未使用的死代码，抛出警告。
  • 第一阶段编译完成后，才会进入第二阶段：编译带cfg(test)配置的专用测试二进制，这一阶段会纳入tests模块的编译，因此测试用例可以正常运行、正常调用can_hold，但这一步的编译结果不会消除第一阶段已经输出的警告。

常见处理方案 #

• 如果can_hold是专门为单元测试编写的辅助方法，不需要在生产代码中使用，可以直接给方法添加#[cfg(test)]标记：常规编译阶段会直接排除该方法的编译，从根源上避免死代码警告。
• 如果can_hold是计划在生产代码中使用的方法，只是当前示例阶段还未编写对应的生产调用逻辑，可以暂时忽略该警告，等生产代码中补上对应调用后，警告会自动消失。
• 如果方法是对外开放给库使用者的公开接口，将方法标记为pub即可，编译器会将其判定为外部可调用的公开API，不会触发死代码警告。

内容的提问来源于stack exchange，提问作者Khorkrak