使用C的Rust

要在一个Rust项目中使用C或者C++，主要有两个步骤:

用Rust封装要暴露出来使用的C API
编译要和Rust代码集成在一起的C或者C++代码

因为对于Rust编译器来说，C++没有一个稳定的ABI，当要将Rust和C或者C++结合时，建议优先选择C。

定义接口

在Rust消费C或者C++代码之前，必须定义(在Rust中定义)，在要被链接的代码中存在什么数据类型和函数签名。在C或者C++中，你要包含一个头文件(.h或者.hpp)，其定义了这个数据。而在Rust中，必须手动地将这些定义翻译成Rust，或者使用一个工具去生成这些定义。

首先，我们将介绍如何将这些定义从C/C++手动地转换为Rust。

封装C函数和数据类型

通常，用C或者C++写的库会提供一个头文件，头文件定义了所有的类型和用于公共接口的函数。如下是一个示例文件:

/* 文件: cool.h */
typedef struct CoolStruct {
    int x;
    int y;
} CoolStruct;

void cool_function(int i, char c, CoolStruct* cs);

当翻译成Rust时，这个接口将看起来像是:

/* File: cool_bindings.rs */
#[repr(C)]
pub struct CoolStruct {
    pub x: cty::c_int,
    pub y: cty::c_int,
}

extern "C" {
    pub fn cool_function(
        i: cty::c_int,
        c: cty::c_char,
        cs: *mut CoolStruct
    );
}

让我们一次看一个语句，来解释每个部分。

#[repr(C)]
pub struct CoolStruct { ... }

默认，Rust不会保证包含在struct中的数据的大小，填充，或者顺序。为了保证与C代码兼容，我们使用#[repr(C)]属性，它指示Rust编译器总是使用和C一样的规则去组织一个结构体中的数据。

pub x: cty::c_int,
pub y: cty::c_int,

由于C或者C++定义一个int或者char的方式很灵活，所以建议使用在cty中定义的基础类型，它将类型从C映射到Rust中的类型。

extern "C" { pub fn cool_function( ... ); }

这个语句定义了一个使用C ABI的函数的签名，叫做cool_function。因为只定义了签名而没有定义函数的主体，所以这个函数的定义将需要在其它地方定义，或者从一个静态库链接进最终的库或者一个二进制文件中。

    i: cty::c_int,
    c: cty::c_char,
    cs: *mut CoolStruct

与我们上面的数据类型一样，我们使用C兼容的定义去定义函数参数的数据类型。为了清晰可见，我们还保留了相同的参数名。

这里我们有了一个新类型，*mut CoolStruct 。因为C没有Rust中像 &mut CoolStruct 这样的引用，替代的是一个裸指针。所以解引用这个指针是unsafe的，因为这个指针实际上可能是一个null指针，因此当与C或者C++代码交互时必须要小心对待那些Rust做出的安全保证。

自动产生接口

有一个叫做bindgen的工具，它可以自动执行这些转换，而不用手动生成这些接口，手动进行这样的操作非常繁琐且容易出错。关于bindgen的使用指令，可以参考bindgen user's manual，常用的步骤大致如下:

收集所有定义了你可能在Rust中会用到的数据类型或者接口的C或者C++头文件。
写一个bindings.h文件，其#include "..."每一个你在步骤一中收集的文件。
将这个bindings.h文件和任何用来编译你代码的编译标识发给bindgen。贴士: 使用Builder.ctypes_prefix("cty") / --ctypes-prefix=cty 和 Builder.use_core() / --use-core 去使生成的代码兼容#![no_std]
bindgen将会在终端窗口输出生成的Rust代码。这个文件可能会被通过管道发送给你项目中的一个文件，比如bindings.rs 。你可能要在你的Rust项目中使用这个文件来与被编译和链接成一个外部库的C/C++代码交互。贴士: 如果你的类型在生成的绑定中被前缀了cty，不要忘记使用cty crate 。

编译你的 C/C++ 代码

因为Rust编译器并不直接知道如何编译C或者C++代码(或者从其它语言来的代码，其提供了一个C接口)，所以必须要静态编译你的非Rust代码。

对于嵌入式项目，这通常意味着把C/C++代码编译成一个静态库文档(比如 cool-library.a)，然后其能在最后链接阶段与你的Rust代码组合起来。

如果你要使用的库已经作为一个静态库文档被发布，那就没必要重新编译你的代码。只需按照上面所述转换提供的接口头文件，且在编译/链接时包含静态库文档。

如果你的代码作为一个源项目(source project)存在，将你的C/C++代码编译成一个静态库将是必须的，要么通过使用你现存的编译系统(比如 make，CMake，等等)，要么通过使用一个被叫做cc crate的工具移植必要的编译步骤。关于这两个，都必须使用一个build.rs脚本。

fn main() {
    cc::Build::new()
        .file("src/foo.c")
        .compile("foo");
}

要把build.rs放在包的根目录下．然后cargo build会在构建包之前编译和执行它．一个静态的名为libfoo.a的归档文件会生成并被放在target文件夹中．

The Embedded Rust Book

使用C的Rust

定义接口

封装C函数和数据类型

自动产生接口

编译你的 C/C++ 代码

Rust的 `build.rs` 编译脚本

使用外部编译系统

使用`cc` crate构建C/C++代码