There are four GN target templates that should be used for Rust projects:
rustc_librarydefines a library and optionally a unit test target. The library can be depended on by other targets.rustc_binarydefines an executable and optionally a unit test target.rustc_testdefines a test-only target.rustc_macrodefines a procedural macro target.
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.
See also: Build Fuchsia with a custom Rust toolchain
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.
Once you have a Cargo.toml for your target you can generate and browse HTML documentation for your target and its dependencies by running:
fx rustdoc path/from/fuchsia/root/to/target:label --openYou 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 macro targets are executed on the host at compile time. Therefore, they cannot depend on other crates that 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.
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 adding --args='rust_cap_lints = "warn"' to
your fx set will allow you to develop locally without being blocked by warnings.
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.
If you're new to Rust or would like someone to review your changes to validate that your usage of Rust is idiomatic, add "Fuchsia Rust Reviewers" as a reviewer to your CL in Gerrit and a reviewer will be assigned.
Email [email protected] with any issues.
{% dynamic if user.is_googler %}
[Googlers only] You can view the list of Rust Reviewers. New reviewers can be nominated by an existing reviewer using this form.
{% dynamic endif %}
Public discussion happens on the [email protected] mailing list.
{% dynamic if user.is_googler %}
[Googlers only] For Googler-only channels, see go/fuchsia-rust-googlers.
{% dynamic endif %}