This package shows how to build Rust code for the most common use cases.
All examples use the Bazelmod configuration format, and some examples come with a Cargo configuration. There are cases when rules have not yet been updated for the new Bazelmod format. In this case, you can apply the hybrid mode by already using the new MODULE.bazel config format while also using a dedicated WORKSPACE.bazelmod file for those rules that have not been updated.
Over time, you can migrate one rule at a time from the WORKSPACE.bazelmod file to the MODULE.bazel and eventually delete the WORKSPACE.bazelmod file when its no longer needed. Please read the official migration guide for details.
Finally, the new MODULE.bazel format is very different from the previous WORKSPACE format, so please be mindful to never mix the two in one file. If unsure, please ask in the #rust channel on Bazel Slack: https://slack.bazel.build/
All code examples support Linux and MacOS. The CI builds all examples on Ubuntu Linux 18.04 and all cross compilation examples are also build for MacOS. The Rust examples do not officially support Windows because Bazel on Windows requires some special configuration. Please use WSL as a workaround or, alternatively, find more Windows-specific recommendations in the official Bazel on Windows guide.
The first example is straightforward and shows how to compile a basic binary with a single source file.
Links:
This example shows how to cross-compile Rust code for Linux on both, aarch64 and x86_64.
Links:
Documentation:
This example shows how to apply compiler optimization to a Rust binary.
Links:
Documentation:
This example shows how to call into a C++ function via C FFI, which comes in handy when Rust re-uses an existing C++ code base.
Links:
Documentation:
This example shows how to manage dependencies with Cargo and use crates_repository to generate Bazel dependencies from a (workspace) Cargo.toml. Note, whenever dependencies in Cargo.toml change, you have to re-generate the Bazel dependencies. See the Readme for details.
Links:
Documentation:
In complex or larger Bazel projects, maintaining various Cargo.toml files may have diminishing returns, so managing Rust dependencies directly with Bazel is a more favorable option. This example shows how to directly declare and use Rust dependencies in Bazel to build an async REST API with Tokio.
Links:
Documentation:
Some organizations require that all external dependencies are vendored, meaning downloaded and stored in the workspace. This helps, for example, to conduct licence scans, apply custom patches, or to ensure full build reproducibility since no download error could possibly occur. This example shows how to vendor Rust dependencies and use those vendored dependencies in a binary target.
Links:
Documentation:
The gRPC protocol is commonly used for communication between internal microservices. This example shows how to build a gRPC client and server in Rust and how to set up a custom toolchain that generates all the proto bindings for Rust. Also, the example comes with a complete Cargo workspace configuration that contains three different crates, which helps to migrate Cargo workspaces to Bazel.
Links:
Documentation:
This example showcases how to configure Bazel to build and publish a Rust binary as OCI container image.
Links:
Documentation: