Rust Repositories

rules_rust_dependencies
rust_analyzer_toolchain_repository
rust_register_toolchains
rust_repositories
rust_repository_set
rust_stdlib_filegroup
rust_toolchain_repository_proxy
rust_toolchain_repository
rust_toolchain_tools_repository
rust_toolchain

rust_stdlib_filegroup

A dedicated filegroup-like rule for Rust stdlib artifacts.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
srcs	The list of targets/files that are components of the rust-stdlib file group	List of labels	required

rust_toolchain

Declares a Rust toolchain for use.

This is for declaring a custom toolchain, eg. for configuring a particular version of rust or supporting a new platform.

Example:

Suppose the core rust team has ported the compiler to a new target CPU, called cpuX. This support can be used in Bazel by defining a new toolchain definition and declaration:

load('@rules_rust//rust:toolchain.bzl', 'rust_toolchain')

rust_toolchain(
    name = "rust_cpuX_impl",
    rustc = "@rust_cpuX//:rustc",
    rustc_lib = "@rust_cpuX//:rustc_lib",
    rust_std = "@rust_cpuX//:rust_std",
    rust_doc = "@rust_cpuX//:rustdoc",
    binary_ext = "",
    staticlib_ext = ".a",
    dylib_ext = ".so",
    stdlib_linkflags = ["-lpthread", "-ldl"],
    os = "linux",
)

toolchain(
    name = "rust_cpuX",
    exec_compatible_with = [
        "@platforms//cpu:cpuX",
    ],
    target_compatible_with = [
        "@platforms//cpu:cpuX",
    ],
    toolchain = ":rust_cpuX_impl",
)

Then, either add the label of the toolchain rule to register_toolchains in the WORKSPACE, or pass it to the "--extra_toolchains" flag for Bazel, and it will be used.

See @rules_rust//rust:repositories.bzl for examples of defining the @rust_cpuX repository with the actual binaries and libraries.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
allocator_library	Target that provides allocator functions when rust_library targets are embedded in a cc_binary.	Label	optional	None
binary_ext	The extension for binaries created from rustc.	String	required
cargo	The location of the cargo binary. Can be a direct source or a filegroup containing one item.	Label	optional	None
clippy_driver	The location of the clippy-driver binary. Can be a direct source or a filegroup containing one item.	Label	optional	None
debug_info	Rustc debug info levels per opt level	Dictionary: String -> String	optional	{“dbg”: “2”, “fastbuild”: “0”, “opt”: “0”}
default_edition	The edition to use for rust_* rules that don't specify an edition. If absent, every rule is required to specify its edition attribute.	String	optional	""
dylib_ext	The extension for dynamic libraries created from rustc.	String	required
env	Environment variables to set in actions.	Dictionary: String -> String	optional	{}
exec_triple	The platform triple for the toolchains execution environment. For more details see: https://docs.bazel.build/versions/master/skylark/rules.html#configurations	String	required
experimental_use_cc_common_link	Label to a boolean build setting that controls whether cc_common.link is used to link rust binaries.	Label	optional	//rust/settings:experimental_use_cc_common_link
extra_exec_rustc_flags	Extra flags to pass to rustc in exec configuration	List of strings	optional	[]
extra_rustc_flags	Extra flags to pass to rustc in non-exec configuration	List of strings	optional	[]
llvm_cov	The location of the llvm-cov binary. Can be a direct source or a filegroup containing one item. If None, rust code is not instrumented for coverage.	Label	optional	None
llvm_profdata	The location of the llvm-profdata binary. Can be a direct source or a filegroup containing one item. If llvm_cov is None, this can be None as well and rust code is not instrumented for coverage.	Label	optional	None
llvm_tools	LLVM tools that are shipped with the Rust toolchain.	Label	optional	None
opt_level	Rustc optimization levels.	Dictionary: String -> String	optional	{“dbg”: “0”, “fastbuild”: “0”, “opt”: “3”}
os	The operating system for the current toolchain	String	required
rust_doc	The location of the rustdoc binary. Can be a direct source or a filegroup containing one item.	Label	required
rust_std	The Rust standard library.	Label	optional	None
rustc	The location of the rustc binary. Can be a direct source or a filegroup containing one item.	Label	required
rustc_lib	The libraries used by rustc during compilation.	Label	optional	None
rustc_srcs	Deprecated: Instead see rust_analyzer_toolchain	Label	optional	None
rustfmt	Deprecated: Instead see rustfmt_toolchain	Label	optional	None
staticlib_ext	The extension for static libraries created from rustc.	String	required
stdlib_linkflags	Additional linker flags to use when Rust standard library is linked by a C++ linker (rustc will deal with these automatically). Subject to location expansion with respect to the srcs of the rust_std attribute.	List of strings	required
target_json	Override the target_triple with a custom target specification. For more details see: https://doc.rust-lang.org/rustc/targets/custom.html	Label	optional	None
target_triple	The platform triple for the toolchains target environment. For more details see: https://docs.bazel.build/versions/master/skylark/rules.html#configurations	String	optional	""

rust_toolchain_repository_proxy

Generates a toolchain-bearing repository that declares the toolchains from some other rust_toolchain_repository.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
exec_compatible_with	A list of constraints for the execution platform for this toolchain.	List of strings	optional	[]
repo_mapping	A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.<p>For example, an entry “@foo”: “@bar” declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target).	Dictionary: String -> String	required
target_compatible_with	A list of constraints for the target platform for this toolchain.	List of strings	optional	[]
target_settings	A list of config_settings that must be satisfied by the target configuration in order for this toolchain to be selected during toolchain resolution.	List of strings	optional	[]
toolchain	The name of the toolchain implementation target.	String	required
toolchain_type	The toolchain type of the toolchain to declare	String	required

rust_toolchain_tools_repository

Composes a single workspace containing the toolchain components for compiling on a given platform to a series of target platforms.

A given instance of this rule should be accompanied by a toolchain_repository_proxy invocation to declare its toolchains to Bazel; the indirection allows separating toolchain selection from toolchain fetching.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
allocator_library	Target that provides allocator functions when rust_library targets are embedded in a cc_binary.	String	optional	""
auth	Auth object compatible with repository_ctx.download to use when downloading files. See repository_ctx.download for more details.	Dictionary: String -> String	optional	{}
dev_components	Whether to download the rustc-dev components (defaults to False). Requires version to be “nightly”.	Boolean	optional	False
edition	The rust edition to be used by default (2015, 2018, or 2021). If absent, every rule is required to specify its edition attribute.	String	optional	""
exec_triple	The Rust-style target that this compiler runs on	String	required
include_rustc_srcs	Whether to download and unpack the rustc source files. These are very large, and slow to unpack, but are required to support rust analyzer. An environment variable RULES_RUST_TOOLCHAIN_INCLUDE_RUSTC_SRCS can also be used to control this attribute. This variable will take precedence over the hard coded attribute. Setting it to true to activates this attribute where all other values deactivate it.	Boolean	optional	False
iso_date	The date of the tool (or None, if the version is a specific version).	String	optional	""
repo_mapping	A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.<p>For example, an entry “@foo”: “@bar” declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target).	Dictionary: String -> String	required
rustfmt_version	The version of the tool among “nightly”, “beta”, or an exact version.	String	optional	""
sha256s	A dict associating tool subdirectories to sha256 hashes. See rust_repositories for more details.	Dictionary: String -> String	optional	{}
target_triple	The Rust-style target that this compiler builds for.	String	required
urls	A list of mirror urls containing the tools from the Rust-lang static file server. These must contain the ‘{}’ used to substitute the tool being fetched (using .format).	List of strings	optional	[“https://static.rust-lang.org/dist/{}.tar.gz”]
version	The version of the tool among “nightly”, “beta”, or an exact version.	String	required

rules_rust_dependencies

Dependencies used in the implementation of rules_rust.

rust_analyzer_toolchain_repository

Assemble a remote rust_analyzer_toolchain target based on the given params.

PARAMETERS

Name	Description	Default Value
name	The name of the toolchain proxy repository contianing the registerable toolchain.	none
version	The version of the tool among “nightly”, "beta', or an exact version.	none
exec_compatible_with	A list of constraints for the execution platform for this toolchain.	`[]`
target_compatible_with	A list of constraints for the target platform for this toolchain.	`[]`
iso_date	The date of the tool.	`None`
sha256s	A dict associating tool subdirectories to sha256 hashes. See rust_repositories for more details.	`None`
urls	A list of mirror urls containing the tools from the Rust-lang static file server. These must contain the ‘{}’ used to substitute the tool being fetched (using .format). Defaults to [‘https://static.rust-lang.org/dist/{}.tar.gz’]	`None`
auth	Auth object compatible with repository_ctx.download to use when downloading files. See repository_ctx.download for more details.	`None`

RETURNS

str: The name of a registerable rust_analyzer_toolchain.

rust_register_toolchains

Emits a default set of toolchains for Linux, MacOS, and Freebsd

Skip this macro and call the rust_repository_set macros directly if you need a compiler for other hosts or for additional target triples.

The sha256 attribute represents a dict associating tool subdirectories to sha256 hashes. As an example:

{
    "rust-1.46.0-x86_64-unknown-linux-gnu": "e3b98bc3440fe92817881933f9564389eccb396f5f431f33d48b979fa2fbdcf5",
    "rustfmt-1.4.12-x86_64-unknown-linux-gnu": "1894e76913303d66bf40885a601462844eec15fca9e76a6d13c390d7000d64b0",
    "rust-std-1.46.0-x86_64-unknown-linux-gnu": "ac04aef80423f612c0079829b504902de27a6997214eb58ab0765d02f7ec1dbc",
}

This would match for exec_triple = "x86_64-unknown-linux-gnu". If not specified, rules_rust pulls from a non-exhaustive list of known checksums..

See load_arbitrary_tool in @rules_rust//rust:repositories.bzl for more details.

PARAMETERS

Name	Description	Default Value
dev_components	Whether to download the rustc-dev components (defaults to False). Requires version to be “nightly”.	`False`
edition	The rust edition to be used by default (2015, 2018, or 2021). If absent, every target is required to specify its edition attribute.	`None`
include_rustc_srcs	Whether to download rustc's src code. This is required in order to use rust-analyzer support. See rust_toolchain_repository.include_rustc_srcs. for more details	`False`
allocator_library	Target that provides allocator functions when rust_library targets are embedded in a cc_binary.	`None`
iso_date	Deprecated: Use versions instead.	`None`
register_toolchains	If true, repositories will be generated to produce and register rust_toolchain targets.	`True`
rustfmt_version	The version of rustfmt.	`"nightly/2022-12-15"`
rust_analyzer_version	The version of Rustc to pair with rust-analyzer.	`None`
sha256s	A dict associating tool subdirectories to sha256 hashes.	`None`
extra_target_triples	Additional rust-style targets that rust toolchains should support.	`["wasm32-unknown-unknown", "wasm32-wasi"]`
urls	A list of mirror urls containing the tools from the Rust-lang static file server. These must contain the ‘{}’ used to substitute the tool being fetched (using .format).	`["https://static.rust-lang.org/dist/{}.tar.gz"]`
version	Deprecated: Use versions instead.	`None`
versions	A list of toolchain versions to download. This paramter only accepts one versions per channel. E.g. [“1.65.0”, “nightly/2022-11-02”, “beta/2020-12-30”].	`[]`