FIDL Rust crate

前提条件

在本教程中，您将使用创建 FIDL 库教程中的 fuchsia.examples FIDL 库。此 FIDL 库的代码位于 //examples/fidl/fuchsia.examples 中。请花点时间检查代码，然后再继续。

概览

本教程详细介绍了如何通过创建单元测试来使用 Rust 中的 FIDL，您可以将该单元测试用作探索 Rust 绑定的“试验场”。

本文档介绍了如何完成以下任务：

编写“hello world”Rust 程序。
将 FIDL 库的 Rust 绑定添加为 build 依赖项。
将 Rust 绑定箱导入到您的代码中。
检查并使用生成的绑定代码。

示例代码位于 Fuchsia 代码库的 //examples/fidl/rust/fidl_crates/ 中。如果您想在学习本教程的过程中编写所有代码，可以移除示例代码：

rm -r examples/fidl/rust/fidl_crates/*

编写“hello world”程序

将主函数添加到 examples/fidl/rust/fidl_crates/src/main.rs：
```
fn main() {
    println!("Hello, world!");
}
```
定义 rustc_binary，然后通过 $host_toolchain 创建对测试的依赖项，这将为主机构建二进制文件。为此，请将以下内容添加到 examples/fidl/rust/fidl_crates/BUILD.gn：
```
import("//build/rust/rustc_binary.gni")


rustc_binary("fidl_crates_bin") {
  edition = "2024"
  sources = [ "src/main.rs" ]
}

group("fidl_crates") {
   testonly = true
   deps = [ ":fidl_crates_bin($host_toolchain)" ]
}
```
注意： rustc_binary 默认情况下会将 src/main.rs 文件作为箱根。也可以将测试代码放在其他文件（例如 hello_world.rs）中，然后在 rustc_binary 声明中明确指定箱根（例如 source_root = "hello_world.rs"）。

在 build 中包含示例

fx set core.x64 --with //examples/fidl/rust/fidl_crates

构建示例
```
fx build
```
运行二进制文件
```
out/default/host_x64/fidl_crates_bin
```
您应该会看到打印的“Hello World”消息。

注意： out/default 中的目录将取决于您的机器和配置。例如，如果您在搭载 ASan 的 ARM 机器上运行，该目录将为 out/default/host_arm64-asan。

添加 Rust FIDL 绑定作为依赖项

对于每个 FIDL 库声明（包括编译 FIDL 中的声明），系统会在原始目标名称后附加 _rust，从而生成一个包含相应库的 Rust 绑定代码的 FIDL 箱。

通过引用此生成的箱来添加对 Rust 绑定的依赖项。新的 rustc_binary 目标应如下所示：

rustc_binary("fidl_crates_bin") {
  edition = "2024"
  deps = [ "//examples/fidl/fuchsia.examples:fuchsia.examples_rust" ]

  sources = [ "src/main.rs" ]
}

（可选）如需查看新生成的绑定，请执行以下操作：

使用 fx build 重新构建。
切换到生成的文件目录：out/default/fidling/gen/examples/fidl/fuchsia.examples/fuchsia.examples。生成的代码位于 fidl_fuchsia_examples.rs 中。如果您已设置其他 build 输出目录，可能需要更改 out/default。您可以使用 cat .fx-build-dir 检查 build 输出目录。

如需详细了解如何查找生成的绑定代码，请参阅查看生成的绑定代码。

在项目中使用 FIDL Rust crate

通过添加测试模块和占位测试，创建一个用于试用生成的 FIDL crate 的位置：

#[cfg(test)]
mod test {
   #[test]
   fn fidl_crates_usage() {

   }
}

然后，您需要通过设置 with_unit_tests 实参来构建包含测试的 build：

rustc_binary("fidl_crates_bin") {
  edition = "2024"
  test_deps = [ "//examples/fidl/fuchsia.examples:fuchsia.examples_rust" ]
  with_unit_tests = true

  sources = [ "src/main.rs" ]
}

这将生成一个 fidl_crates_bin_test 目标，然后应将其添加到 build 组中：

group("fidl_crates") {
  testonly = true
  deps = [
    ":fidl_crates_bin($host_toolchain)",
    ":fidl_crates_bin_test($host_toolchain)",
  ]
}

如需导入箱，请将以下内容添加到 tests 模块的顶部。在 Fuchsia 树中，FIDL crate 通常会别名为较短的名称，以实现简洁性：

    use fidl_fuchsia_examples as fex;

使用生成的绑定代码

现在，您可以使用生成的绑定代码编写一些代码了。如需详细了解绑定，请参阅 Rust 绑定参考文档。

如需开始使用，您还可以使用以下示例代码。您可以将此内容添加到 fidl_crates_usage 测试中：

let flags = fex::FileMode::READ | fex::FileMode::WRITE;
println!("{:?}", flags);

let from_raw = fex::LocationType::from_primitive(1).expect("Could not create LocationType");
assert_eq!(from_raw, fex::LocationType::Museum);
assert_eq!(fex::LocationType::Restaurant.into_primitive(), 3);

let red = fex::Color { id: 0u32, name: "red".to_string() };
println!("{:?}", red);

let int_val = fex::JsonValue::IntValue(1);
let str_val = fex::JsonValue::StringValue("1".to_string());
println!("{:?}", int_val);
assert_ne!(int_val, str_val);

let user = fex::User { age: Some(20), ..Default::default() };
println!("{:?}", user);
assert!(user.age.is_some());

如需重新构建并重新运行测试，请运行以下命令：

fx test -vo fidl_crates_bin_test