Rust 使用cbindgen

引入 cbindgen

cbindgen 是一个用于生成 C 兼容的头文件工具，可以帮助你在 Rust 项目中更方便地与 C 或其他语言进行交互。使用 cbindgen 可以使你更容易地将 Rust 代码封装成可以被其他语言调用的形式，这对于创建库或者与现有 C/C++ 代码库集成非常有用。

安装 cbindgen

首先需要安装 cbindgen。你可以通过 cargo 直接安装它：

cargo install cbindgen

安装完成后，可以通过命令行运行 cbindgen 来生成头文件。

创建项目

为了演示如何使用 cbindgen，我们先创建一个新的 Rust 项目：

cargo new my_rust_project
cd my_rust_project

编写 Rust 代码

在 src/lib.rs 中编写一些简单的 Rust 函数，这些函数将会被封装成 C 函数。例如：

-- -------------------- ---- -------
--- ---------
------------
--- ------ --- -- ------ ---- -- ---- -- --- -
    - - -
-

--- ----------
------------
--- ------ --- -- ------------ ---- -- ---- -- --- -
    - - -
-

这里使用了 #[no_mangle] 和 extern "C" 属性来确保函数名不被 Rust 改变，并且函数签名符合 C 语言的标准。

配置 cbindgen

接下来，需要为项目配置 cbindgen。在项目根目录下创建一个名为 cbindgen.toml 的文件，并添加以下内容：

language = "C"

header = """
// 由 cbindgen 自动生成的头文件。
"""

include_guard = "MY_RUST_PROJECT_H"

这个配置文件指定了输出语言为 C，添加了一个自定义的头文件注释，并设置了包含保护符（防止重复包含）。

生成头文件

在项目的根目录下运行以下命令来生成头文件：

cbindgen --config cbindgen.toml -o src/my_rust_project.h

这将根据 cbindgen.toml 文件中的配置生成一个头文件 src/my_rust_project.h。

使用生成的头文件

现在你可以在其他 C/C++ 项目中使用这个头文件了。例如，在一个 C 文件中包含这个头文件并调用之前定义的 Rust 函数：

#include <stdio.h>
#include "my_rust_project.h"

int main() {
    printf("The sum of 5 and 3 is %d\n", add(5, 3));
    printf("The sum of 5.0 and 3.0 is %f\n", add_float(5.0, 3.0));
    return 0;
}

编译时需要链接 Rust 生成的静态库或动态库。具体的编译步骤取决于你的环境和需求，但通常包括以下步骤：

• 编译 Rust 代码为静态或动态库：

  cargo build --release

• 将生成的库文件（如 libmy_rust_project.a 或 libmy_rust_project.so）与 C 程序一起链接。

总结

通过上述步骤，你可以看到使用 cbindgen 可以方便地将 Rust 代码转换为 C 兼容的接口。这对于希望利用 Rust 语言优势的同时与现有 C/C++ 代码库进行集成的开发者来说是一个非常有用的工具。此外，cbindgen 还支持许多高级配置选项，允许你定制生成的头文件的外观和行为。