Rust

Build

There are four GN target templates which should be used for Rust projects:

The examples/rust directory has some examples of Rust packages that use these targets, as do the Rust FIDL examples.

Note: The example Rust BUILD.gn file contains the line group("rust"). In this instance, rust refers to the directory the .gn file is in, not the language.

Building with a custom toolchain

If you want to test out Fuchsia with your own custom-built versions of rustc or cargo, you can set the rustc_prefix argument to fx set, like this:

fx set core.x64 --release --args "rustc_prefix=\"/path/to/bin/dir\""

Cargo.toml

Fuchsia Rust targets are not built with cargo. That said, you can generate Cargo.toml files for use with external tooling. This functionality is not guaranteed to work.

Autogenerated docs

You can generate and browse HTML documentation for your target and its dependencies by running:

fx rustdoc path/from/fuchsia/root/to/target:label --open

Tests

You can run unit tests on connected devices using fx, with the fx test {package name} command. See Testing Rust code for information on adding and running tests.

Procedural macros

Procedural macro targets are executed on the host at compile time. Therefore, they cannot depend on other crates which are only available on device, e.g. zircon.

Negative tests, e.g. asserting that a macro fails to compile with a specific error, are currently not supported.

Warnings & Errors

By default our build configuration makes all Rust warnings into errors. This requirement can be onerous during development, and on your local machine you may wish to see warnings as warnings and let CQ enforce the hard boundary.

The rust_cap_lints GN arg allows you to control this behavior in your development environment. Setting rust_cap_lints = "warn" in fx args or fx set will allow you to develop locally without being blocked by warnings.

Style

We don't currently have a style guide for Rust, but you should run fx rustfmt or fx format-code before submitting. We mostly use the rustfmt defaults, but have a couple custom settings.

Rust Idiomatic Usage Review

If you're new to Rust, and would like someone to review your changes to validate that your usage of Rust is idiomatic, contact one of the following (or add them as a reviewer to your change.)

(To volunteer for this, please add yourself to the list above and upload the change with one of the above as the reviewer).

Communication channels

Public discussion happens on the rust@fuchsia.com mailing list. For Googler-only channels, see go/fuchsia-rust-googlers.

Existing Fuchsia Rust libraries

Going further