如何在Rust中实现类似C++宏的代码依赖检查以优化报错信息？

需求背景 #

我平时用Rust做竞赛编程，会把常用数据结构存为Vim代码片段：

• 执行:I unionfind插入UnionFind结构代码
• 执行:I kruskal插入依赖UnionFind的Kruskal结构代码

如果忘记先插入UnionFind，编译器只会报标准的error[E0412]: cannot find type 'UnionFind' in this scope，我需要更友好的提示，比如UnionFind is not imported. Execute :I unionfind in Vim.。

现有约束：

• 竞赛环境仅支持单文件提交，无法使用模块系统
• 为了可维护性，不想在Kruskal片段中复制UnionFind代码
• 给片段插入工具添加依赖管理是最后备选方案

实现方案 #

Rust没有C++那样的预处理器#error，但可以利用类型系统检查和compile_error!宏（Rust 1.57+支持，标准库内置）实现类似的自定义依赖检查提示。

步骤1：修改UnionFind代码片段 #

在UnionFind结构定义前添加一个空常量作为导入标记（辅助类型检查，可选）：

// UnionFind导入标记，仅用于依赖检查
const _UNIONFIND_IMPORTED: () = ();

struct UnionFind {
    parent: Vec<usize>,
}

impl UnionFind {
    fn new(size: usize) -> Self {
        Self { parent: (0..size).collect() }
    }

    fn find(&mut self, x: usize) -> usize {
        if self.parent[x] != x {
            self.parent[x] = self.find(self.parent[x]);
        }
        self.parent[x]
    }

    fn union(&mut self, x: usize, y: usize) {
        let x_root = self.find(x);
        let y_root = self.find(y);
        if x_root != y_root {
            self.parent[y_root] = x_root;
        }
    }
}

步骤2：修改Kruskal代码片段 #

添加自定义依赖检查宏，在Kruskal结构定义前调用，触发自定义错误提示：

// 自定义依赖检查宏，用于提示缺失的代码片段
macro_rules! require_snippet {
    ($type:ident, $hint:expr) => {
        #[allow(unused, dead_code)]
        const _: () = {
            // 尝试引用目标类型，触发基础类型检查
            let _: $type;
            // 触发自定义错误提示
            #[cfg(not(any()))]
            compile_error!($hint);
        };
    };
}

// 检查UnionFind是否已导入，若未导入则显示自定义提示
require_snippet!(UnionFind, "UnionFind is not imported. Execute :I unionfind in Vim.");

struct Kruskal {
    uf: UnionFind,
    edges: Vec<(usize, usize, i32)>,
}

impl Kruskal {
    fn new(size: usize) -> Self {
        Self { uf: UnionFind::new(size), edges: Vec::new() }
    }

    fn add_edge(&mut self, u: usize, v: usize, w: i32) {
        self.edges.push((u, v, w));
    }

    fn run(&mut self) -> i32 {
        self.edges.sort_by_key(|&(_, _, w)| w);
        let mut total = 0;
        for (u, v, w) in &self.edges {
            if self.uf.find(*u) != self.uf.find(*v) {
                self.uf.union(*u, *v);
                total += w;
            }
        }
        total
    }
}

效果演示 #

如果忘记插入UnionFind片段，编译时会输出：

error[E0412]: cannot find type `UnionFind` in this scope
 --> src/main.rs:6:13
  |
6 |         let _: $type;
  |             ^^^^^^^ not found in this scope
...
9 |             compile_error!($hint);
  |             -------------------- help: consider importing this type: `UnionFind`

error: compile_error! macro invoked
 --> src/main.rs:9:13
  |
9 |             compile_error!($hint);
  |             ^^^^^^^^^^^^^^^^^^^^^ UnionFind is not imported. Execute :I unionfind in Vim.

其中第二条错误信息就是我们自定义的友好提示，用户能直接知道需要执行哪个Vim命令来解决问题。

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