diff --git a/rust_wasm_bindgen.html b/rust_wasm_bindgen.html
index a88b11bf3f..c78e91e32e 100755
--- a/rust_wasm_bindgen.html
+++ b/rust_wasm_bindgen.html
@@ -237,12 +237,14 @@
Info about wasm-bindgen outputs.
Name Description
Depset[File]: The Javascript files produced by wasm-bindgen. str: The path to the root of the wasm-bindgen --out-dir directory. File: The snippets directory produced by wasm-bindgen. Depset[File]: The Typescript files produced by wasm-bindgen. File: The .wasm file generated by wasm-bindgen.
diff --git a/searchindex.js b/searchindex.js
index b856591725..c811a23961 100755
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Object.assign(window.search, {"doc_urls":["index.html#rules-rust","index.html#setup","index.html#bzlmod","index.html#workspace","index.html#specifying-rust-version","index.html#supported-bazel-versions","index.html#supported-platforms","rules.html#rules","rules.html#experimental-rules","rules.html#3rd-party-rules","rules.html#full-api","rust.html#rust","rust.html#capture_clippy_output","rust.html#error_format","rust.html#extra_rustc_flag","rust.html#extra_rustc_flags","rust.html#rust_binary","rust.html#rust_library","rust.html#rust_library_group","rust.html#rust_proc_macro","rust.html#rust_shared_library","rust.html#rust_static_library","rust.html#rust_test","rust.html#example-test-directory","rust.html#rust_test_suite","rust_doc.html#rust-doc","rust_doc.html#rust_doc","rust_doc.html#rust_doc_test","rust_clippy.html#rust-clippy","rust_clippy.html#overview","rust_clippy.html#setup","rust_clippy.html#rust_clippy","rust_clippy.html#rust_clippy_aspect","rust_fmt.html#rust-fmt","rust_fmt.html#overview","rust_fmt.html#setup","rust_fmt.html#tips","rust_fmt.html#rustfmt_test","rust_fmt.html#rustfmt_toolchain","rust_fmt.html#rustfmt_aspect","cargo.html#cargo","cargo.html#cargo_dep_env","cargo.html#cargo_build_script","cargo.html#cargo_env","cargo.html#cargo_bootstrap_repository","rust_analyzer.html#rust-analyzer","rust_analyzer.html#overview","rust_analyzer.html#setup","rust_analyzer.html#rust_analyzer_toolchain","rust_analyzer.html#rust_analyzer_aspect","flatten.html#rust-rules","flatten.html#capture_clippy_output","flatten.html#cargo_dep_env","flatten.html#error_format","flatten.html#extra_rustc_flag","flatten.html#extra_rustc_flags","flatten.html#incompatible_flag","flatten.html#rust_analyzer_toolchain","flatten.html#rust_binary","flatten.html#rust_clippy","flatten.html#rust_doc","flatten.html#rust_doc_test","flatten.html#rust_library","flatten.html#rust_library_group","flatten.html#rust_proc_macro","flatten.html#rust_shared_library","flatten.html#rust_static_library","flatten.html#rust_stdlib_filegroup","flatten.html#rust_test","flatten.html#example-test-directory","flatten.html#rust_toolchain","flatten.html#rustfmt_test","flatten.html#rustfmt_toolchain","flatten.html#crateinfo","flatten.html#depinfo","flatten.html#stdlibinfo","flatten.html#cargo_build_script","flatten.html#cargo_env","flatten.html#rules_rust_dependencies","flatten.html#rust_analyzer_toolchain_repository","flatten.html#rust_register_toolchains","flatten.html#rust_repositories","flatten.html#rust_repository_set","flatten.html#rust_test_suite","flatten.html#rust_toolchain_repository","flatten.html#rust_analyzer_aspect","flatten.html#rust_clippy_aspect","flatten.html#rustfmt_aspect","flatten.html#cargo_bootstrap_repository","flatten.html#rust_toolchain_repository_proxy","flatten.html#rust_toolchain_tools_repository","external_crates.html#external-dependencies","crate_universe_bzlmod.html#crate-universe","crate_universe_bzlmod.html#table-of-contents","crate_universe_bzlmod.html#setup","crate_universe_bzlmod.html#dependencies","crate_universe_bzlmod.html#cargo-workspaces","crate_universe_bzlmod.html#direct-dependencies","crate_universe_bzlmod.html#vendored-dependencies","crate_universe_bzlmod.html#crate","crate_universe_bzlmod.html#annotation","crate_universe_bzlmod.html#from_cargo","crate_universe_bzlmod.html#from_specs","crate_universe_bzlmod.html#spec","crate_universe.html#crate-universe","crate_universe.html#setup","crate_universe.html#rules","crate_universe.html#utility-macros","crate_universe.html#workflows","crate_universe.html#cargo-workspaces","crate_universe.html#direct-packages","crate_universe.html#binary-dependencies","crate_universe.html#dependencies-api","crate_universe.html#building-crates-with-complicated-dependencies","crate_universe.html#some-things-work-without-intervention","crate_universe.html#supplying-extra-tools-to-build","crate_universe.html#building-with-bazel-and-supplying-via-an-override","crate_universe.html#crates_vendor","crate_universe.html#repinning--updating-dependencies","crate_universe.html#aliases","crate_universe.html#all_crate_deps","crate_universe.html#crateannotation","crate_universe.html#crateselect","crate_universe.html#cratespec","crate_universe.html#crateworkspace_member","crate_universe.html#crate_deps","crate_universe.html#crate_repositories","crate_universe.html#crate_universe_dependencies","crate_universe.html#render_config","crate_universe.html#splicing_config","crate_universe.html#crates_repository","crate_universe.html#repinning--updating-dependencies-1","upstream_tooling.html#upstream-tooling","extensions.html#extensions","extensions.html#setup","extensions.html#bzlmod","extensions.html#workspace","rust_bindgen.html#rules_rust_bindgen","rust_bindgen.html#rules","rust_bindgen.html#setup","rust_bindgen.html#rust_bindgen","rust_bindgen.html#rust_bindgen_toolchain","rust_bindgen.html#rust_bindgen_library","rust_mdbook.html#rules_rust_mdbook","rust_mdbook.html#rules","rust_mdbook.html#setup","rust_mdbook.html#bzlmod","rust_mdbook.html#workspace","rust_mdbook.html#mdbook","rust_mdbook.html#mdbook_server","rust_mdbook.html#mdbook_toolchain","rust_prost.html#rules_rust_prost","rust_prost.html#rules","rust_prost.html#setup","rust_prost.html#rust_prost_library","rust_prost.html#rust_prost_toolchain","rust_prost.html#rust_prost_transform","rust_protobuf.html#rules_rust_protobuf","rust_protobuf.html#setup","rust_protobuf.html#rust_grpc_library","rust_protobuf.html#rust_proto_library","rust_wasm_bindgen.html#rules_rust_wasm_bindgen","rust_wasm_bindgen.html#rules","rust_wasm_bindgen.html#setup","rust_wasm_bindgen.html#interfacing-with-javascript-rules","rust_wasm_bindgen.html#rust_wasm_bindgen","rust_wasm_bindgen.html#rust_wasm_bindgen_toolchain","rust_wasm_bindgen.html#rustwasmbindgeninfo"],"index":{"documentStore":{"docInfo":{"0":{"body":7,"breadcrumbs":3,"title":2},"1":{"body":12,"breadcrumbs":2,"title":1},"10":{"body":5,"breadcrumbs":3,"title":2},"100":{"body":444,"breadcrumbs":5,"title":1},"101":{"body":213,"breadcrumbs":5,"title":1},"102":{"body":196,"breadcrumbs":5,"title":1},"103":{"body":134,"breadcrumbs":5,"title":1},"104":{"body":24,"breadcrumbs":6,"title":2},"105":{"body":30,"breadcrumbs":5,"title":1},"106":{"body":2,"breadcrumbs":5,"title":1},"107":{"body":7,"breadcrumbs":6,"title":2},"108":{"body":24,"breadcrumbs":5,"title":1},"109":{"body":109,"breadcrumbs":6,"title":2},"11":{"body":12,"breadcrumbs":3,"title":1},"110":{"body":119,"breadcrumbs":6,"title":2},"111":{"body":146,"breadcrumbs":6,"title":2},"112":{"body":16,"breadcrumbs":6,"title":2},"113":{"body":21,"breadcrumbs":8,"title":4},"114":{"body":74,"breadcrumbs":8,"title":4},"115":{"body":48,"breadcrumbs":8,"title":4},"116":{"body":48,"breadcrumbs":9,"title":5},"117":{"body":110,"breadcrumbs":5,"title":1},"118":{"body":414,"breadcrumbs":7,"title":3},"119":{"body":101,"breadcrumbs":5,"title":1},"12":{"body":23,"breadcrumbs":3,"title":1},"120":{"body":106,"breadcrumbs":5,"title":1},"121":{"body":381,"breadcrumbs":5,"title":1},"122":{"body":26,"breadcrumbs":5,"title":1},"123":{"body":149,"breadcrumbs":5,"title":1},"124":{"body":31,"breadcrumbs":5,"title":1},"125":{"body":40,"breadcrumbs":5,"title":1},"126":{"body":14,"breadcrumbs":5,"title":1},"127":{"body":40,"breadcrumbs":5,"title":1},"128":{"body":243,"breadcrumbs":5,"title":1},"129":{"body":38,"breadcrumbs":5,"title":1},"13":{"body":25,"breadcrumbs":3,"title":1},"130":{"body":183,"breadcrumbs":5,"title":1},"131":{"body":716,"breadcrumbs":7,"title":3},"132":{"body":36,"breadcrumbs":4,"title":2},"133":{"body":9,"breadcrumbs":2,"title":1},"134":{"body":16,"breadcrumbs":2,"title":1},"135":{"body":51,"breadcrumbs":2,"title":1},"136":{"body":52,"breadcrumbs":2,"title":1},"137":{"body":9,"breadcrumbs":3,"title":1},"138":{"body":3,"breadcrumbs":3,"title":1},"139":{"body":57,"breadcrumbs":3,"title":1},"14":{"body":24,"breadcrumbs":3,"title":1},"140":{"body":109,"breadcrumbs":3,"title":1},"141":{"body":126,"breadcrumbs":3,"title":1},"142":{"body":105,"breadcrumbs":3,"title":1},"143":{"body":3,"breadcrumbs":3,"title":1},"144":{"body":3,"breadcrumbs":3,"title":1},"145":{"body":0,"breadcrumbs":3,"title":1},"146":{"body":4,"breadcrumbs":3,"title":1},"147":{"body":8,"breadcrumbs":3,"title":1},"148":{"body":44,"breadcrumbs":3,"title":1},"149":{"body":48,"breadcrumbs":3,"title":1},"15":{"body":52,"breadcrumbs":3,"title":1},"150":{"body":32,"breadcrumbs":3,"title":1},"151":{"body":11,"breadcrumbs":3,"title":1},"152":{"body":2,"breadcrumbs":3,"title":1},"153":{"body":207,"breadcrumbs":3,"title":1},"154":{"body":28,"breadcrumbs":3,"title":1},"155":{"body":138,"breadcrumbs":3,"title":1},"156":{"body":108,"breadcrumbs":3,"title":1},"157":{"body":11,"breadcrumbs":3,"title":1},"158":{"body":203,"breadcrumbs":3,"title":1},"159":{"body":121,"breadcrumbs":3,"title":1},"16":{"body":797,"breadcrumbs":3,"title":1},"160":{"body":118,"breadcrumbs":3,"title":1},"161":{"body":9,"breadcrumbs":3,"title":1},"162":{"body":2,"breadcrumbs":3,"title":1},"163":{"body":51,"breadcrumbs":3,"title":1},"164":{"body":43,"breadcrumbs":5,"title":3},"165":{"body":89,"breadcrumbs":3,"title":1},"166":{"body":70,"breadcrumbs":3,"title":1},"167":{"body":31,"breadcrumbs":3,"title":1},"17":{"body":572,"breadcrumbs":3,"title":1},"18":{"body":47,"breadcrumbs":3,"title":1},"19":{"body":475,"breadcrumbs":3,"title":1},"2":{"body":41,"breadcrumbs":2,"title":1},"20":{"body":586,"breadcrumbs":3,"title":1},"21":{"body":521,"breadcrumbs":3,"title":1},"22":{"body":126,"breadcrumbs":3,"title":1},"23":{"body":674,"breadcrumbs":5,"title":3},"24":{"body":109,"breadcrumbs":3,"title":1},"25":{"body":2,"breadcrumbs":4,"title":2},"26":{"body":170,"breadcrumbs":3,"title":1},"27":{"body":117,"breadcrumbs":3,"title":1},"28":{"body":2,"breadcrumbs":4,"title":2},"29":{"body":14,"breadcrumbs":3,"title":1},"3":{"body":48,"breadcrumbs":2,"title":1},"30":{"body":48,"breadcrumbs":3,"title":1},"31":{"body":72,"breadcrumbs":3,"title":1},"32":{"body":57,"breadcrumbs":3,"title":1},"33":{"body":3,"breadcrumbs":4,"title":2},"34":{"body":29,"breadcrumbs":3,"title":1},"35":{"body":85,"breadcrumbs":3,"title":1},"36":{"body":28,"breadcrumbs":3,"title":1},"37":{"body":30,"breadcrumbs":3,"title":1},"38":{"body":52,"breadcrumbs":3,"title":1},"39":{"body":61,"breadcrumbs":3,"title":1},"4":{"body":66,"breadcrumbs":4,"title":3},"40":{"body":4,"breadcrumbs":3,"title":1},"41":{"body":98,"breadcrumbs":3,"title":1},"42":{"body":414,"breadcrumbs":3,"title":1},"43":{"body":59,"breadcrumbs":3,"title":1},"44":{"body":307,"breadcrumbs":3,"title":1},"45":{"body":2,"breadcrumbs":4,"title":2},"46":{"body":19,"breadcrumbs":3,"title":1},"47":{"body":165,"breadcrumbs":3,"title":1},"48":{"body":38,"breadcrumbs":3,"title":1},"49":{"body":36,"breadcrumbs":3,"title":1},"5":{"body":35,"breadcrumbs":4,"title":3},"50":{"body":40,"breadcrumbs":4,"title":2},"51":{"body":23,"breadcrumbs":3,"title":1},"52":{"body":98,"breadcrumbs":3,"title":1},"53":{"body":25,"breadcrumbs":3,"title":1},"54":{"body":24,"breadcrumbs":3,"title":1},"55":{"body":52,"breadcrumbs":3,"title":1},"56":{"body":26,"breadcrumbs":3,"title":1},"57":{"body":38,"breadcrumbs":3,"title":1},"58":{"body":797,"breadcrumbs":3,"title":1},"59":{"body":72,"breadcrumbs":3,"title":1},"6":{"body":42,"breadcrumbs":3,"title":2},"60":{"body":170,"breadcrumbs":3,"title":1},"61":{"body":117,"breadcrumbs":3,"title":1},"62":{"body":572,"breadcrumbs":3,"title":1},"63":{"body":47,"breadcrumbs":3,"title":1},"64":{"body":475,"breadcrumbs":3,"title":1},"65":{"body":586,"breadcrumbs":3,"title":1},"66":{"body":521,"breadcrumbs":3,"title":1},"67":{"body":31,"breadcrumbs":3,"title":1},"68":{"body":126,"breadcrumbs":3,"title":1},"69":{"body":674,"breadcrumbs":5,"title":3},"7":{"body":38,"breadcrumbs":2,"title":1},"70":{"body":541,"breadcrumbs":3,"title":1},"71":{"body":30,"breadcrumbs":3,"title":1},"72":{"body":52,"breadcrumbs":3,"title":1},"73":{"body":187,"breadcrumbs":3,"title":1},"74":{"body":90,"breadcrumbs":3,"title":1},"75":{"body":106,"breadcrumbs":3,"title":1},"76":{"body":414,"breadcrumbs":3,"title":1},"77":{"body":59,"breadcrumbs":3,"title":1},"78":{"body":5,"breadcrumbs":3,"title":1},"79":{"body":124,"breadcrumbs":3,"title":1},"8":{"body":8,"breadcrumbs":3,"title":2},"80":{"body":389,"breadcrumbs":3,"title":1},"81":{"body":17,"breadcrumbs":3,"title":1},"82":{"body":303,"breadcrumbs":3,"title":1},"83":{"body":109,"breadcrumbs":3,"title":1},"84":{"body":250,"breadcrumbs":3,"title":1},"85":{"body":36,"breadcrumbs":3,"title":1},"86":{"body":57,"breadcrumbs":3,"title":1},"87":{"body":61,"breadcrumbs":3,"title":1},"88":{"body":307,"breadcrumbs":3,"title":1},"89":{"body":127,"breadcrumbs":3,"title":1},"9":{"body":26,"breadcrumbs":4,"title":3},"90":{"body":312,"breadcrumbs":3,"title":1},"91":{"body":9,"breadcrumbs":4,"title":2},"92":{"body":30,"breadcrumbs":6,"title":2},"93":{"body":12,"breadcrumbs":6,"title":2},"94":{"body":32,"breadcrumbs":5,"title":1},"95":{"body":12,"breadcrumbs":5,"title":1},"96":{"body":211,"breadcrumbs":6,"title":2},"97":{"body":116,"breadcrumbs":6,"title":2},"98":{"body":337,"breadcrumbs":6,"title":2},"99":{"body":71,"breadcrumbs":5,"title":1}},"docs":{"0":{"body":"This repository provides rules for building Rust projects with Bazel .","breadcrumbs":"Introduction » Rules Rust","id":"0","title":"Rules Rust"},"1":{"body":"The rules are released, and releases can be found on the GitHub Releases page . We recommend using the latest release from that page.","breadcrumbs":"Introduction » Setup","id":"1","title":"Setup"},"10":{"body":"You can also browse the full API in one page .","breadcrumbs":"Rules » Full API","id":"10","title":"Full API"},"100":{"body":"Attributes Name Description Type Mandatory Default deps A list of labels to add to a crate's rust_library::deps attribute. List of strings optional [] data A list of labels to add to a crate's rust_library::data attribute. List of strings optional [] additive_build_file A file containing extra contents to write to the bottom of generated BUILD files. Label optional None additive_build_file_content Extra contents to write to the bottom of generated BUILD files. String optional \"\" alias_rule Alias rule to use instead of native.alias(). Overrides render_config 's 'default_alias_rule'. String optional \"\" build_script_data A list of labels to add to a crate's cargo_build_script::data attribute. List of strings optional [] build_script_data_glob A list of glob patterns to add to a crate's cargo_build_script::data attribute List of strings optional [] build_script_deps A list of labels to add to a crate's cargo_build_script::deps attribute. List of strings optional [] build_script_env Additional environment variables to set on a crate's cargo_build_script::env attribute. Dictionary: String -> String optional {} build_script_proc_macro_deps A list of labels to add to a crate's cargo_build_script::proc_macro_deps attribute. List of strings optional [] build_script_rundir An override for the build script's rundir attribute. String optional \"\" build_script_rustc_env Additional environment variables to set on a crate's cargo_build_script::env attribute. Dictionary: String -> String optional {} build_script_toolchains A list of labels to set on a crates's cargo_build_script::toolchains attribute. List of labels optional [] build_script_tools A list of labels to add to a crate's cargo_build_script::tools attribute. List of strings optional [] compile_data A list of labels to add to a crate's rust_library::compile_data attribute. List of strings optional [] compile_data_glob A list of glob patterns to add to a crate's rust_library::compile_data attribute. List of strings optional [] crate The name of the crate the annotation is applied to String required crate_features A list of strings to add to a crate's rust_library::crate_features attribute. List of strings optional [] data_glob A list of glob patterns to add to a crate's rust_library::data attribute. List of strings optional [] disable_pipelining If True, disables pipelining for library targets for this crate. Boolean optional False extra_aliased_targets A list of targets to add to the generated aliases in the root crate_universe repository. Dictionary: String -> String optional {} gen_all_binaries If true, generates rust_binary targets for all of the crates bins Boolean optional False gen_binaries As a list, the subset of the crate's bins that should get rust_binary targets produced. List of strings optional [] gen_build_script An authorative flag to determine whether or not to produce cargo_build_script targets for the current crate. Supported values are 'on', 'off', and 'auto'. String optional \"auto\" override_target_bin An optional alternate taget to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Label optional None override_target_build_script An optional alternate taget to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Label optional None override_target_lib An optional alternate taget to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Label optional None override_target_proc_macro An optional alternate taget to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Label optional None patch_args The patch_args attribute of a Bazel repository rule. See http_archive.patch_args List of strings optional [] patch_tool The patch_tool attribute of a Bazel repository rule. See http_archive.patch_tool String optional \"\" patches The patches attribute of a Bazel repository rule. See http_archive.patches List of labels optional [] proc_macro_deps A list of labels to add to a crate's rust_library::proc_macro_deps attribute. List of strings optional [] repositories A list of repository names specified from crate.from_cargo(name=...) that this annotation is applied to. Defaults to all repositories. List of strings optional [] rustc_env Additional variables to set on a crate's rust_library::rustc_env attribute. Dictionary: String -> String optional {} rustc_env_files A list of labels to set on a crate's rust_library::rustc_env_files attribute. List of strings optional [] rustc_flags A list of strings to set on a crate's rust_library::rustc_flags attribute. List of strings optional [] shallow_since An optional timestamp used for crates originating from a git repository instead of a crate registry. This flag optimizes fetching the source code. String optional \"\" version The versions of the crate the annotation is applied to. Defaults to all versions. String optional \"*\"","breadcrumbs":"External Crates » crate_universe (bzlmod) » annotation","id":"100","title":"annotation"},"101":{"body":"Generates a repo @crates from a Cargo.toml / Cargo.lock pair. Attributes Name Description Type Mandatory Default name The name of the repo to generate Name optional \"crates\" cargo_config A Cargo configuration file. Label optional None cargo_lockfile The path to an existing Cargo.lock file Label optional None generate_binaries Whether to generate rust_binary targets for all the binary crates in every package. By default only the rust_library targets are generated. Boolean optional False generate_build_scripts Whether or not to generate cargo build scripts by default. Boolean optional True manifests A list of Cargo manifests (Cargo.toml files). List of labels optional [] splicing_config The configuration flags to use for splicing Cargo maniests. Use //crate_universe:defs.bzl\\%rsplicing_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" supported_platform_triples A set of all platform triples to consider when generating dependencies. List of strings optional [\"aarch64-apple-darwin\", \"aarch64-apple-ios\", \"aarch64-apple-ios-sim\", \"aarch64-linux-android\", \"aarch64-pc-windows-msvc\", \"aarch64-unknown-fuchsia\", \"aarch64-unknown-linux-gnu\", \"aarch64-unknown-nixos-gnu\", \"aarch64-unknown-nto-qnx710\", \"arm-unknown-linux-gnueabi\", \"armv7-linux-androideabi\", \"armv7-unknown-linux-gnueabi\", \"i686-apple-darwin\", \"i686-linux-android\", \"i686-pc-windows-msvc\", \"i686-unknown-freebsd\", \"i686-unknown-linux-gnu\", \"powerpc-unknown-linux-gnu\", \"riscv32imc-unknown-none-elf\", \"riscv64gc-unknown-none-elf\", \"s390x-unknown-linux-gnu\", \"thumbv7em-none-eabi\", \"thumbv8m.main-none-eabi\", \"wasm32-unknown-unknown\", \"wasm32-wasip1\", \"x86_64-apple-darwin\", \"x86_64-apple-ios\", \"x86_64-linux-android\", \"x86_64-pc-windows-msvc\", \"x86_64-unknown-freebsd\", \"x86_64-unknown-fuchsia\", \"x86_64-unknown-linux-gnu\", \"x86_64-unknown-nixos-gnu\", \"x86_64-unknown-none\"]","breadcrumbs":"External Crates » crate_universe (bzlmod) » from_cargo","id":"101","title":"from_cargo"},"102":{"body":"Generates a repo @crates from the defined spec tags. Attributes Name Description Type Mandatory Default name The name of the repo to generate. Name optional \"crates\" cargo_config A Cargo configuration file. Label optional None generate_binaries Whether to generate rust_binary targets for all the binary crates in every package. By default only the rust_library targets are generated. Boolean optional False generate_build_scripts Whether or not to generate cargo build scripts by default. Boolean optional True splicing_config The configuration flags to use for splicing Cargo maniests. Use //crate_universe:defs.bzl\\%rsplicing_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" supported_platform_triples A set of all platform triples to consider when generating dependencies. List of strings optional [\"aarch64-apple-darwin\", \"aarch64-apple-ios\", \"aarch64-apple-ios-sim\", \"aarch64-linux-android\", \"aarch64-pc-windows-msvc\", \"aarch64-unknown-fuchsia\", \"aarch64-unknown-linux-gnu\", \"aarch64-unknown-nixos-gnu\", \"aarch64-unknown-nto-qnx710\", \"arm-unknown-linux-gnueabi\", \"armv7-linux-androideabi\", \"armv7-unknown-linux-gnueabi\", \"i686-apple-darwin\", \"i686-linux-android\", \"i686-pc-windows-msvc\", \"i686-unknown-freebsd\", \"i686-unknown-linux-gnu\", \"powerpc-unknown-linux-gnu\", \"riscv32imc-unknown-none-elf\", \"riscv64gc-unknown-none-elf\", \"s390x-unknown-linux-gnu\", \"thumbv7em-none-eabi\", \"thumbv8m.main-none-eabi\", \"wasm32-unknown-unknown\", \"wasm32-wasip1\", \"x86_64-apple-darwin\", \"x86_64-apple-ios\", \"x86_64-linux-android\", \"x86_64-pc-windows-msvc\", \"x86_64-unknown-freebsd\", \"x86_64-unknown-fuchsia\", \"x86_64-unknown-linux-gnu\", \"x86_64-unknown-nixos-gnu\", \"x86_64-unknown-none\"]","breadcrumbs":"External Crates » crate_universe (bzlmod) » from_specs","id":"102","title":"from_specs"},"103":{"body":"Attributes Name Description Type Mandatory Default artifact Set to 'bin' to pull in a binary crate as an artifact dependency. Requires a nightly Cargo. String optional \"\" branch The git branch of the remote crate. Tied with the git param. Only one of branch, tag or rev may be specified. Specifying rev is recommended for fully-reproducible builds. String optional \"\" default_features Maps to the default-features flag. Boolean optional True features A list of features to use for the crate. List of strings optional [] git The Git url to use for the crate. Cannot be used with version. String optional \"\" lib If using artifact = 'bin', additionally setting lib = True declares a dependency on both the package's library and binary, as opposed to just the binary. Boolean optional False package The explicit name of the package. String required rev The git revision of the remote crate. Tied with the git param. Only one of branch, tag or rev may be specified. String optional \"\" tag The git tag of the remote crate. Tied with the git param. Only one of branch, tag or rev may be specified. Specifying rev is recommended for fully-reproducible builds. String optional \"\" version The exact version of the crate. Cannot be used with git. String optional \"\"","breadcrumbs":"External Crates » crate_universe (bzlmod) » spec","id":"103","title":"spec"},"104":{"body":"Crate Universe is a set of Bazel rule for generating Rust targets using Cargo. This doc describes using crate_universe from a WORKSPACE file. If you're using bzlmod, please see the bzlmod equivalent of this doc .","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Crate Universe","id":"104","title":"Crate Universe"},"105":{"body":"After loading rules_rust in your workspace, set the following to begin using crate_universe: load(\"@rules_rust//crate_universe:repositories.bzl\", \"crate_universe_dependencies\") crate_universe_dependencies() Note that if the current version of rules_rust is not a release artifact, you may need to set additional flags such as bootstrap = True on the crate_universe_dependencies call above or crates_repository::generator_urls in uses of crates_repository.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Setup","id":"105","title":"Setup"},"106":{"body":"crates_repository crates_vendor","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Rules","id":"106","title":"Rules"},"107":{"body":"crate_universe_dependencies crate.annotation crate.select crate.spec crate.workspace_member render_config splicing_config","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Utility Macros","id":"107","title":"Utility Macros"},"108":{"body":"The crates_repository rule (the primary repository rule of rules_rust's cargo support) supports a number of different ways users can express and organize their dependencies. The most common are listed below though there are more to be found in the ./examples/crate_universe directory.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Workflows","id":"108","title":"Workflows"},"109":{"body":"One of the simpler ways to wire up dependencies would be to first structure your project into a Cargo workspace . The crates_repository rule can ingest a root Cargo.toml file and generate dependencies from there. load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_repository\") crates_repository( name = \"crate_index\", cargo_lockfile = \"//:Cargo.lock\", lockfile = \"//:Cargo.Bazel.lock\", manifests = [\"//:Cargo.toml\"],\n) load(\"@crate_index//:defs.bzl\", \"crate_repositories\") crate_repositories() The generated crates_repository contains helper macros which make collecting dependencies for Bazel targets simpler. Notably, the all_crate_deps and aliases macros (see Dependencies API ) commonly allow the Cargo.toml files to be the single source of truth for dependencies. Since these macros come from the generated repository, the dependencies and alias definitions they return will automatically update BUILD targets. load(\"@crate_index//:defs.bzl\", \"aliases\", \"all_crate_deps\")\nload(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"lib\", aliases = aliases(), deps = all_crate_deps( normal = True, ), proc_macro_deps = all_crate_deps( proc_macro = True, ),\n) rust_test( name = \"unit_test\", crate = \":lib\", aliases = aliases( normal_dev = True, proc_macro_dev = True, ), deps = all_crate_deps( normal_dev = True, ), proc_macro_deps = all_crate_deps( proc_macro_dev = True, ),\n)","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Cargo Workspaces","id":"109","title":"Cargo Workspaces"},"11":{"body":"rust_binary rust_library rust_library_group rust_static_library rust_shared_library rust_proc_macro rust_test rust_test_suite error_format extra_rustc_flag extra_rustc_flags capture_clippy_output","breadcrumbs":"Rules » rust » Rust","id":"11","title":"Rust"},"110":{"body":"In cases where Rust targets have heavy interractions with other Bazel targests ( Cc , Proto , etc.), maintaining Cargo.toml files may have deminishing returns as things like rust-analyzer begin to be confused about missing targets or environment variables defined only in Bazel. In workspaces like this, it may be desirable to have a \"Cargo free\" setup. crates_repository supports this through the packages attribute. load(\"@rules_rust//crate_universe:defs.bzl\", \"crate\", \"crates_repository\", \"render_config\") crates_repository( name = \"crate_index\", cargo_lockfile = \"//:Cargo.lock\", lockfile = \"//:Cargo.Bazel.lock\", packages = { \"async-trait\": crate.spec( version = \"0.1.51\", ), \"mockall\": crate.spec( version = \"0.10.2\", ), \"tokio\": crate.spec( version = \"1.12.0\", ), }, # Setting the default package name to `\"\"` forces the use of the macros defined in this repository # to always use the root package when looking for dependencies or aliases. This should be considered # optional as the repository also exposes alises for easy access to all dependencies. render_config = render_config( default_package_name = \"\" ),\n) load(\"@crate_index//:defs.bzl\", \"crate_repositories\") crate_repositories() Consuming dependencies may be more ergonomic in this case through the aliases defined in the new repository. load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"lib\", deps = [ \"@crate_index//:tokio\", ], proc_macro_deps = [ \"@crate_index//:async-trait\", ],\n) rust_test( name = \"unit_test\", crate = \":lib\", deps = [ \"@crate_index//:mockall\", ],\n)","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Direct Packages","id":"110","title":"Direct Packages"},"111":{"body":"Neither of the above approaches supports depending on binary-only packages. In order to depend on a Cargo package that contains binaries and no library, you will need to do one of the following: Fork the package to add an empty lib.rs, which makes the package visible to Cargo metadata and compatible with the above approaches; Or handwrite your own build target for the binary, use http_archive to import its source code, and use crates_repository to make build targets for its dependencies. This is demonstrated below using the rustfilt crate as an example. # in WORKSPACE.bazel load(\"@bazel_tools//tools/build_defs/repo:http.bzl\", \"http_archive\") http_archive( name = \"rustfilt\", build_file = \"//rustfilt:BUILD.rustfilt.bazel\", sha256 = \"c8d748b182c8f95224336d20dcc5609598af612581ce60cfb29da4dc8d0091f2\", strip_prefix = \"rustfilt-0.2.1\", type = \"tar.gz\", urls = [\"https://static.crates.io/crates/rustfilt/rustfilt-0.2.1.crate\"],\n) load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_repository\") crates_repository( name = \"rustfilt_deps\", cargo_lockfile = \"//rustfilt:Cargo.lock\", manifests = [\"@rustfilt//:Cargo.toml\"],\n) load(\"@rustfilt_deps//:defs.bzl\", rustfilt_deps = \"crate_repositories\") rustfilt_deps() # in rustfilt/BUILD.rustfilt.bazel load(\"@rules_rust//rust:defs.bzl\", \"rust_binary\") rust_binary( name = \"rustfilt\", srcs = glob([\"src/**/*.rs\"]), edition = \"2018\", deps = [ \"@rustfilt_deps//:clap\", \"@rustfilt_deps//:lazy_static\", \"@rustfilt_deps//:regex\", \"@rustfilt_deps//:rustc-demangle\", ],\n) If you use either crates_repository or crates_vendor to depend on a Cargo package that contains both a library crate and binaries, by default only the library gets made available to Bazel. To generate Bazel targets for the binary crates as well, you must opt in to it with an annotation on the package: load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_repository\", \"crate\") crates_repository( name = \"crate_index\", annotations = { \"thepackage\": [crate.annotation( gen_binaries = True, # Or, to expose just a subset of the package's binaries by name: gen_binaries = [\"rustfilt\"], )], }, # Or, to expose every binary of every package: generate_binaries = True, ...\n)","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Binary dependencies","id":"111","title":"Binary dependencies"},"112":{"body":"After rendering dependencies, convenience macros may also be generated to provide convenient accessors to larger sections of the dependency graph. aliases crate_deps all_crate_deps crate_repositories","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Dependencies API","id":"112","title":"Dependencies API"},"113":{"body":"Some crates have build.rs scripts which are complicated to run. Typically these build C++ (or other languages), or attempt to find pre-installed libraries on the build machine. There are a few approaches to making sure these run:","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Building crates with complicated dependencies","id":"113","title":"Building crates with complicated dependencies"},"114":{"body":"Some build scripts will happily run without any support needed. rules_rust already supplies a configured C++ toolchain as input to build script execution, and sets variables like CC, CXX, LD, LDFLAGS, etc as needed. Many crates which invoke a compiler with the default environment, or forward these env vars, will Just Work (e.g. if using cc-rs ). rules_rust is open to PRs which make build scripts more likely to work by default with intervention assuming they're broadly applicable (e.g. setting extra widely-known env vars is probably fine, wiring up additional toolchains like cmake that aren't present by default for most Bazel users probably isn't).","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Some things work without intervention","id":"114","title":"Some things work without intervention"},"115":{"body":"Some build scripts can be made to work by pulling in some extra files and making them available to the build script. Commonly this is done by passing the file to the build_script_data annotation for the crate, and using build_script_env to tell the build script where the file is. That env var may often use $(execroot) to get the path to the label, or $${pwd}/ as a prefix if the path given is relative to the execroot (as will frequently happen when using a toolchain).A There is an example of this in the \"complicated dependencies\" section of https://github.com/bazelbuild/rules_rust/blob/main/examples/crate_universe/WORKSPACE.bazel which builds libz-ng-sys.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Supplying extra tools to build","id":"115","title":"Supplying extra tools to build"},"116":{"body":"Some build scripts have hooks to allow replacing parts that are complicated to build with output prepared by Bazel. We can use those hooks by specifying paths (generally using the build_script_data and build_script_env annotations) and pointing them at labels which Bazel will then build. These env vars may often use $(execroot) to get the path to the label, or $${pwd}/ as a prefix if the path given is relative to the execroot (as will frequently happen when using a toolchain). There is an example of this in the \"complicated dependencies\" section of https://github.com/bazelbuild/rules_rust/blob/main/examples/crate_universe/WORKSPACE.bazel which builds boring-sys.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Building with Bazel and supplying via an override","id":"116","title":"Building with Bazel and supplying via an override"},"117":{"body":"crates_vendor(name, annotations, bazel, buildifier, cargo_bazel, cargo_config, cargo_lockfile, generate_binaries, generate_build_scripts, generate_target_compatible_with, manifests, mode, packages, render_config, repository_name, splicing_config, supported_platform_triples, vendor_path) A rule for defining Rust dependencies (crates) and writing targets for them to the current workspace. This rule is useful for users whose workspaces are expected to be consumed in other workspaces as the rendered BUILD files reduce the number of workspace dependencies, allowing for easier loads. This rule handles all the same workflows crate_universe rules do. Example: Given the following workspace structure: [workspace]/ WORKSPACE BUILD Cargo.toml 3rdparty/ BUILD src/ main.rs The following is something that'd be found in 3rdparty/BUILD: load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_vendor\", \"crate\") crates_vendor( name = \"crates_vendor\", annotations = { \"rand\": [crate.annotation( default_features = False, features = [\"small_rng\"], )], }, cargo_lockfile = \"//:Cargo.Bazel.lock\", manifests = [\"//:Cargo.toml\"], mode = \"remote\", vendor_path = \"crates\", tags = [\"manual\"],\n) The above creates a target that can be run to write BUILD files into the 3rdparty directory next to where the target is defined. To run it, simply call: bazel run //3rdparty:crates_vendor","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crates_vendor","id":"117","title":"crates_vendor"},"118":{"body":"Repinning dependencies is controlled by both the CARGO_BAZEL_REPIN environment variable or the --repin flag to the crates_vendor binary. To update dependencies, simply add the flag ro your bazel run invocation. bazel run //3rdparty:crates_vendor -- --repin Under the hood, --repin will trigger a cargo update call against the generated workspace. The following table describes how to control particular values passed to the cargo update command. Value Cargo command Any of [true, 1, yes, on, workspace] cargo update --workspace Any of [full, eager, all] cargo update package_name cargo upgrade --package package_name package_name@1.2.3 cargo upgrade --package package_name --precise 1.2.3 ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required annotations Extra settings to apply to crates. See crate.annotation . Dictionary: String -> List of strings optional {} bazel The path to a bazel binary used to locate the output_base for the current workspace. Label optional None buildifier The path to a buildifier binary used to format generated BUILD files. Label optional \"@rules_rust//crate_universe/private/vendor:buildifier\" cargo_bazel The cargo-bazel binary to use for vendoring. If this attribute is not set, then a CARGO_BAZEL_GENERATOR_PATH action env will be used. Label optional \"@@rules_rust~~cu~cargo_bazel_bootstrap//:binary\" cargo_config A Cargo configuration file. Label optional None cargo_lockfile The path to an existing Cargo.lock file Label optional None generate_binaries Whether to generate rust_binary targets for all the binary crates in every package. By default only the rust_library targets are generated. Boolean optional False generate_build_scripts Whether or not to generate cargo build scripts by default. Boolean optional True generate_target_compatible_with DEPRECATED: Moved to render_config. Boolean optional True manifests A list of Cargo manifests (Cargo.toml files). List of labels optional [] mode Flags determining how crates should be vendored. local is where crate source and BUILD files are written to the repository. remote is where only BUILD files are written and repository rules used to fetch source code. String optional \"remote\" packages A set of crates (packages) specifications to depend on. See crate.spec . Dictionary: String -> String optional {} render_config The configuration flags to use for rendering. Use //crate_universe:defs.bzl\\%render_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" repository_name The name of the repository to generate for remote vendor modes. If unset, the label name will be used String optional \"\" splicing_config The configuration flags to use for splicing Cargo maniests. Use //crate_universe:defs.bzl\\%rsplicing_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" supported_platform_triples A set of all platform triples to consider when generating dependencies. List of strings optional [\"aarch64-apple-darwin\", \"aarch64-apple-ios\", \"aarch64-apple-ios-sim\", \"aarch64-linux-android\", \"aarch64-pc-windows-msvc\", \"aarch64-unknown-fuchsia\", \"aarch64-unknown-linux-gnu\", \"aarch64-unknown-nixos-gnu\", \"aarch64-unknown-nto-qnx710\", \"arm-unknown-linux-gnueabi\", \"armv7-linux-androideabi\", \"armv7-unknown-linux-gnueabi\", \"i686-apple-darwin\", \"i686-linux-android\", \"i686-pc-windows-msvc\", \"i686-unknown-freebsd\", \"i686-unknown-linux-gnu\", \"powerpc-unknown-linux-gnu\", \"riscv32imc-unknown-none-elf\", \"riscv64gc-unknown-none-elf\", \"s390x-unknown-linux-gnu\", \"thumbv7em-none-eabi\", \"thumbv8m.main-none-eabi\", \"wasm32-unknown-unknown\", \"wasm32-wasip1\", \"x86_64-apple-darwin\", \"x86_64-apple-ios\", \"x86_64-linux-android\", \"x86_64-pc-windows-msvc\", \"x86_64-unknown-freebsd\", \"x86_64-unknown-fuchsia\", \"x86_64-unknown-linux-gnu\", \"x86_64-unknown-nixos-gnu\", \"x86_64-unknown-none\"] vendor_path The path to a directory to write files into. Absolute paths will be treated as relative to the workspace root String optional \"crates\"","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Repinning / Updating Dependencies","id":"118","title":"Repinning / Updating Dependencies"},"119":{"body":"aliases(normal, normal_dev, proc_macro, proc_macro_dev, build, build_proc_macro, package_name) Produces a map of Crate alias names to their original label If no dependency kinds are specified, normal and proc_macro are used by default. Setting any one flag will otherwise determine the contents of the returned dict. PARAMETERS Name Description Default Value normal If True, normal dependencies are included in the output list. False normal_dev If True, normal dev dependencies will be included in the output list.. False proc_macro If True, proc_macro dependencies are included in the output list. False proc_macro_dev If True, dev proc_macro dependencies are included in the output list. False build If True, build dependencies are included in the output list. False build_proc_macro If True, build proc_macro dependencies are included in the output list. False package_name The package name of the set of dependencies to look up. Defaults to native.package_name() when unset. None RETURNS dict: The aliases of all associated packages","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » aliases","id":"119","title":"aliases"},"12":{"body":"capture_clippy_output(name) Control whether to print clippy output or store it to a file, using the configured error_format. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » capture_clippy_output","id":"12","title":"capture_clippy_output"},"120":{"body":"all_crate_deps(normal, normal_dev, proc_macro, proc_macro_dev, build, build_proc_macro, package_name) Finds the fully qualified label of all requested direct crate dependencies for the package where this macro is called. If no parameters are set, all normal dependencies are returned. Setting any one flag will otherwise impact the contents of the returned list. PARAMETERS Name Description Default Value normal If True, normal dependencies are included in the output list. False normal_dev If True, normal dev dependencies will be included in the output list.. False proc_macro If True, proc_macro dependencies are included in the output list. False proc_macro_dev If True, dev proc_macro dependencies are included in the output list. False build If True, build dependencies are included in the output list. False build_proc_macro If True, build proc_macro dependencies are included in the output list. False package_name The package name of the set of dependencies to look up. Defaults to native.package_name() when unset. None RETURNS list: A list of labels to generated rust targets (str)","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » all_crate_deps","id":"120","title":"all_crate_deps"},"121":{"body":"crate.annotation(version, additive_build_file, additive_build_file_content, alias_rule, build_script_compile_data, build_script_data, build_script_tools, build_script_data_glob, build_script_deps, build_script_env, build_script_proc_macro_deps, build_script_rundir, build_script_rustc_env, build_script_toolchains, build_script_use_default_shell_env, compile_data, compile_data_glob, crate_features, data, data_glob, deps, extra_aliased_targets, gen_binaries, disable_pipelining, gen_build_script, patch_args, patch_tool, patches, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, shallow_since, override_targets) A collection of extra attributes and settings for a particular crate PARAMETERS Name Description Default Value version The version or semver-conditions to match with a crate. The wildcard * matches any version, including prerelease versions. \"*\" additive_build_file A file containing extra contents to write to the bottom of generated BUILD files. None additive_build_file_content Extra contents to write to the bottom of generated BUILD files. None alias_rule Alias rule to use instead of native.alias(). Overrides render_config 's 'default_alias_rule'. None build_script_compile_data A list of labels to add to a crate's cargo_build_script::compile_data attribute. None build_script_data A list of labels to add to a crate's cargo_build_script::data attribute. None build_script_tools A list of labels to add to a crate's cargo_build_script::tools attribute. None build_script_data_glob A list of glob patterns to add to a crate's cargo_build_script::data attribute. None build_script_deps A list of labels to add to a crate's cargo_build_script::deps attribute. None build_script_env Additional environment variables to set on a crate's cargo_build_script::env attribute. None build_script_proc_macro_deps A list of labels to add to a crate's cargo_build_script::proc_macro_deps attribute. None build_script_rundir An override for the build script's rundir attribute. None build_script_rustc_env Additional environment variables to set on a crate's cargo_build_script::env attribute. None build_script_toolchains A list of labels to set on a crates's cargo_build_script::toolchains attribute. None build_script_use_default_shell_env Whether or not to include the default shell environment for the build script action. None compile_data A list of labels to add to a crate's rust_library::compile_data attribute. None compile_data_glob A list of glob patterns to add to a crate's rust_library::compile_data attribute. None crate_features A list of strings to add to a crate's rust_library::crate_features attribute. None data A list of labels to add to a crate's rust_library::data attribute. None data_glob A list of glob patterns to add to a crate's rust_library::data attribute. None deps A list of labels to add to a crate's rust_library::deps attribute. None extra_aliased_targets A list of targets to add to the generated aliases in the root crate_universe repository. None gen_binaries As a list, the subset of the crate's bins that should get rust_binary targets produced. Or True to generate all, False to generate none. None disable_pipelining If True, disables pipelining for library targets for this crate. False gen_build_script An authorative flag to determine whether or not to produce cargo_build_script targets for the current crate. None patch_args The patch_args attribute of a Bazel repository rule. See http_archive.patch_args None patch_tool The patch_tool attribute of a Bazel repository rule. See http_archive.patch_tool None patches The patches attribute of a Bazel repository rule. See http_archive.patches None proc_macro_deps A list of labels to add to a crate's rust_library::proc_macro_deps attribute. None rustc_env Additional variables to set on a crate's rust_library::rustc_env attribute. None rustc_env_files A list of labels to set on a crate's rust_library::rustc_env_files attribute. None rustc_flags A list of strings to set on a crate's rust_library::rustc_flags attribute. None shallow_since An optional timestamp used for crates originating from a git repository instead of a crate registry. This flag optimizes fetching the source code. None override_targets A dictionary of alternate targets to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Keys can be proc-marco, custom-build, lib, bin. None RETURNS string: A json encoded string containing the specified version and separately all other inputs.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crate.annotation","id":"121","title":"crate.annotation"},"122":{"body":"crate.select(common, selects) A Starlark Select for crate.annotation(). PARAMETERS Name Description Default Value common A value that applies to all configurations. none selects A dict of target_triple to values. none RETURNS struct: A struct representing the Starlark Select.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crate.select","id":"122","title":"crate.select"},"123":{"body":"crate.spec(package, version, artifact, lib, default_features, features, git, branch, tag, rev) A constructor for a crate dependency. See specifying dependencies in the Cargo book for more details. PARAMETERS Name Description Default Value package The explicit name of the package (used when attempting to alias a crate). None version The exact version of the crate. Cannot be used with git. None artifact Set to \"bin\" to pull in a binary crate as an artifact dependency. Requires a nightly Cargo. None lib If using artifact = \"bin\", additionally setting lib = True declares a dependency on both the package's library and binary, as opposed to just the binary. None default_features Maps to the default-features flag. True features A list of features to use for the crate [] git The Git url to use for the crate. Cannot be used with version. None branch The git branch of the remote crate. Tied with the git param. Only one of branch, tag or rev may be specified. Specifying rev is recommended for fully-reproducible builds. None tag The git tag of the remote crate. Tied with the git param. Only one of branch, tag or rev may be specified. Specifying rev is recommended for fully-reproducible builds. None rev The git revision of the remote crate. Tied with the git param. Only one of branch, tag or rev may be specified. None RETURNS string: A json encoded string of all inputs","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crate.spec","id":"123","title":"crate.spec"},"124":{"body":"crate.workspace_member(version, sha256) Define information for extra workspace members PARAMETERS Name Description Default Value version The semver of the crate to download. Must be an exact version. none sha256 The sha256 checksum of the .crate file. None RETURNS string: A json encoded string of all inputs","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crate.workspace_member","id":"124","title":"crate.workspace_member"},"125":{"body":"crate_deps(deps, package_name) Finds the fully qualified label of the requested crates for the package where this macro is called. PARAMETERS Name Description Default Value deps The desired list of crate targets. none package_name The package name of the set of dependencies to look up. Defaults to native.package_name(). None RETURNS list: A list of labels to generated rust targets (str)","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crate_deps","id":"125","title":"crate_deps"},"126":{"body":"crate_repositories() A macro for defining repositories for all generated crates. RETURNS A list of repos visible to the module through the module extension.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crate_repositories","id":"126","title":"crate_repositories"},"127":{"body":"crate_universe_dependencies(rust_version, bootstrap, kwargs) Define dependencies of the cargo-bazel Rust target PARAMETERS Name Description Default Value rust_version The version of rust to use when generating dependencies. \"1.83.0\" bootstrap If true, a cargo_bootstrap_repository target will be generated. False kwargs Arguments to pass through to cargo_bazel_bootstrap. none RETURNS list[struct(repo=str, is_dev_dep=bool)]: A list of the repositories defined by this macro.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crate_universe_dependencies","id":"127","title":"crate_universe_dependencies"},"128":{"body":"render_config(build_file_template, crate_label_template, crate_repository_template, crates_module_template, default_alias_rule, default_package_name, generate_target_compatible_with, platforms_template, regen_command, vendor_mode, generate_rules_license_metadata) Various settings used to configure rendered outputs The template parameters each support a select number of format keys. A description of each key can be found below where the supported keys for each template can be found in the parameter docs key definition name The name of the crate. Eg tokio repository The rendered repository name for the crate. Directly relates to crate_repository_template. triple A platform triple. Eg x86_64-unknown-linux-gnu version The crate version. Eg 1.2.3 target The library or binary target of the crate file The basename of a file PARAMETERS Name Description Default Value build_file_template The base template to use for BUILD file names. The available format keys are [{name}, {version}`]. \"//:BUILD.{name}-{version}.bazel\" crate_label_template The base template to use for crate labels. The available format keys are [{repository}, {name}, {version}, {target}]. \"@{repository}__{name}-{version}//:{target}\" crate_repository_template The base template to use for Crate label repository names. The available format keys are [{repository}, {name}, {version}]. \"{repository}__{name}-{version}\" crates_module_template The pattern to use for the defs.bzl and BUILD.bazel file names used for the crates module. The available format keys are [{file}]. \"//:{file}\" default_alias_rule Alias rule to use when generating aliases for all crates. Acceptable values are 'alias', 'dbg'/'fastbuild'/'opt' (transitions each crate's compilation_mode) or a string representing a rule in the form '
:' that takes a single label parameter 'actual'. See '@crate_index//:alias_rules.bzl' for an example. \"alias\" default_package_name The default package name to use in the rendered macros. This affects the auto package detection of things like all_crate_deps. None generate_target_compatible_with Whether to generate target_compatible_with annotations on the generated BUILD files. This catches a target_triplebeing targeted that isn't declared in supported_platform_triples. True platforms_template The base template to use for platform names. See platforms documentation . The available format keys are [{triple}]. \"@rules_rust//rust/platform:{triple}\" regen_command An optional command to demonstrate how generated files should be regenerated. None vendor_mode An optional configuration for rendirng content to be rendered into repositories. None generate_rules_license_metadata Whether to generate rules license metedata False RETURNS string: A json encoded struct to match the Rust config::RenderConfig struct","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » render_config","id":"128","title":"render_config"},"129":{"body":"splicing_config(resolver_version) Various settings used to configure Cargo manifest splicing behavior. PARAMETERS Name Description Default Value resolver_version The resolver version to use in generated Cargo manifests. This flag is only used when splicing a manifest from direct package definitions. See crates_repository::packages. \"2\" RETURNS str: A json encoded string of the parameters provided","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » splicing_config","id":"129","title":"splicing_config"},"13":{"body":"error_format(name) Change the --error-format flag from the command line with --@rules_rust//rust/settings:error_format. See rustc documentation for valid values. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » error_format","id":"13","title":"error_format"},"130":{"body":"crates_repository(name, annotations, cargo_config, cargo_lockfile, compressed_windows_toolchain_names, generate_binaries, generate_build_scripts, generate_target_compatible_with, generator, generator_sha256s, generator_urls, isolated, lockfile, manifests, packages, quiet, render_config, repin_instructions, repo_mapping, rust_toolchain_cargo_template, rust_toolchain_rustc_template, rust_version, splicing_config, supported_platform_triples) A rule for defining and downloading Rust dependencies (crates). This rule handles all the same workflows crate_universe rules do. Environment Variables: variable usage CARGO_BAZEL_GENERATOR_SHA256 The sha256 checksum of the file located at CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_URL The URL of a cargo-bazel binary. This variable takes precedence over attributes and can use file:// for local paths CARGO_BAZEL_ISOLATED An authorative flag as to whether or not the CARGO_HOME environment variable should be isolated from the host configuration CARGO_BAZEL_REPIN An indicator that the dependencies represented by the rule should be regenerated. REPIN may also be used. See Repinning / Updating Dependencies for more details. CARGO_BAZEL_REPIN_ONLY A comma-delimited allowlist for rules to execute repinning. Can be useful if multiple instances of the repository rule are used in a Bazel workspace, but repinning should be limited to one of them. Example: Given the following workspace structure: [workspace]/ WORKSPACE.bazel BUILD.bazel Cargo.toml Cargo.Bazel.lock src/ main.rs The following is something that'd be found in the WORKSPACE file: load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_repository\", \"crate\") crates_repository( name = \"crate_index\", annotations = { \"rand\": [crate.annotation( default_features = False, features = [\"small_rng\"], )], }, cargo_lockfile = \"//:Cargo.Bazel.lock\", lockfile = \"//:cargo-bazel-lock.json\", manifests = [\"//:Cargo.toml\"], # Should match the version represented by the currently registered `rust_toolchain`. rust_version = \"1.60.0\",\n) The above will create an external repository which contains aliases and macros for accessing Rust targets found in the dependency graph defined by the given manifests. NOTE : The cargo_lockfile and lockfile must be manually created. The rule unfortunately does not yet create it on its own. When initially setting up this rule, an empty file should be created and then populated by repinning dependencies.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crates_repository","id":"130","title":"crates_repository"},"131":{"body":"Dependency syncing and updating is done in the repository rule which means it's done during the analysis phase of builds. As mentioned in the environments variable table above, the CARGO_BAZEL_REPIN (or REPIN) environment variables can be used to force the rule to update dependencies and potentially render a new lockfile. Given an instance of this repository rule named crate_index, the easiest way to repin dependencies is to run: CARGO_BAZEL_REPIN=1 bazel sync --only=crate_index This will result in all dependencies being updated for a project. The CARGO_BAZEL_REPIN environment variable can also be used to customize how dependencies are updated. The following table shows translations from environment variable values to the equivilant cargo update command that is called behind the scenes to update dependencies. Value Cargo command Any of [true, 1, yes, on, workspace] cargo update --workspace Any of [full, eager, all] cargo update package_name cargo upgrade --package package_name package_name@1.2.3 cargo upgrade --package package_name@1.2.3 package_name@1.2.3=4.5.6 cargo upgrade --package package_name@1.2.3 --precise=4.5.6 If the crates_repository is used multiple times in the same Bazel workspace (e.g. for multiple independent Rust workspaces), it may additionally be useful to use the CARGO_BAZEL_REPIN_ONLY environment variable, which limits execution of the repinning to one or multiple instances of the crates_repository rule via a comma-delimited allowlist: CARGO_BAZEL_REPIN=1 CARGO_BAZEL_REPIN_ONLY=crate_index bazel sync --only=crate_index ATTRIBUTES Name Description Type Mandatory Default name A unique name for this repository. Name required annotations Extra settings to apply to crates. See crate.annotation . Dictionary: String -> List of strings optional {} cargo_config A Cargo configuration file Label optional None cargo_lockfile The path used to store the crates_repository specific Cargo.lock file. In the case that your crates_repository corresponds directly with an existing Cargo.toml file which has a paired Cargo.lock file, that Cargo.lock file should be used here, which will keep the versions used by cargo and bazel in sync. Label required compressed_windows_toolchain_names Wether or not the toolchain names of windows toolchains are expected to be in a compressed format. Boolean optional True generate_binaries Whether to generate rust_binary targets for all the binary crates in every package. By default only the rust_library targets are generated. Boolean optional False generate_build_scripts Whether or not to generate cargo build scripts by default. Boolean optional True generate_target_compatible_with DEPRECATED: Moved to render_config. Boolean optional True generator The absolute label of a generator. Eg. @cargo_bazel_bootstrap//:cargo-bazel. This is typically used when bootstrapping String optional \"\" generator_sha256s Dictionary of host_triple -> sha256 for a cargo-bazel binary. Dictionary: String -> String optional {} generator_urls URL template from which to download the cargo-bazel binary. {host_triple} and will be filled in according to the host platform. Dictionary: String -> String optional {} isolated If true, CARGO_HOME will be overwritten to a directory within the generated repository in order to prevent other uses of Cargo from impacting having any effect on the generated targets produced by this rule. For users who either have multiple crate_repository definitions in a WORKSPACE or rapidly re-pin dependencies, setting this to false may improve build times. This variable is also controled by CARGO_BAZEL_ISOLATED environment variable. Boolean optional True lockfile The path to a file to use for reproducible renderings. If set, this file must exist within the workspace (but can be empty) before this rule will work. Label optional None manifests A list of Cargo manifests (Cargo.toml files). List of labels optional [] packages A set of crates (packages) specifications to depend on. See crate.spec . Dictionary: String -> String optional {} quiet If stdout and stderr should not be printed to the terminal. Boolean optional True render_config The configuration flags to use for rendering. Use //crate_universe:defs.bzl\\%render_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" repin_instructions Instructions to re-pin the repository if required. Many people have wrapper scripts for keeping dependencies up to date, and would like to point users to that instead of the default. String optional \"\" repo_mapping In WORKSPACE context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.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).This attribute is not supported in MODULE.bazel context (when invoking a repository rule inside a module extension's implementation function). Dictionary: String -> String optional rust_toolchain_cargo_template The template to use for finding the host cargo binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'rustc.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_toolchain_rustc_template The template to use for finding the host rustc binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'cargo.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_version The version of Rust the currently registered toolchain is using. Eg. 1.56.0, or nightly/2021-09-08 String optional \"1.83.0\" splicing_config The configuration flags to use for splicing Cargo maniests. Use //crate_universe:defs.bzl\\%rsplicing_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" supported_platform_triples A set of all platform triples to consider when generating dependencies. List of strings optional [\"aarch64-apple-darwin\", \"aarch64-apple-ios\", \"aarch64-apple-ios-sim\", \"aarch64-linux-android\", \"aarch64-pc-windows-msvc\", \"aarch64-unknown-fuchsia\", \"aarch64-unknown-linux-gnu\", \"aarch64-unknown-nixos-gnu\", \"aarch64-unknown-nto-qnx710\", \"arm-unknown-linux-gnueabi\", \"armv7-linux-androideabi\", \"armv7-unknown-linux-gnueabi\", \"i686-apple-darwin\", \"i686-linux-android\", \"i686-pc-windows-msvc\", \"i686-unknown-freebsd\", \"i686-unknown-linux-gnu\", \"powerpc-unknown-linux-gnu\", \"riscv32imc-unknown-none-elf\", \"riscv64gc-unknown-none-elf\", \"s390x-unknown-linux-gnu\", \"thumbv7em-none-eabi\", \"thumbv8m.main-none-eabi\", \"wasm32-unknown-unknown\", \"wasm32-wasip1\", \"x86_64-apple-darwin\", \"x86_64-apple-ios\", \"x86_64-linux-android\", \"x86_64-pc-windows-msvc\", \"x86_64-unknown-freebsd\", \"x86_64-unknown-fuchsia\", \"x86_64-unknown-linux-gnu\", \"x86_64-unknown-nixos-gnu\", \"x86_64-unknown-none\"] ENVIRONMENT VARIABLES This repository rule depends on the following environment variables: CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_SHA256 CARGO_BAZEL_REPIN REPIN CARGO_BAZEL_REPIN_ONLY CARGO_BAZEL_ISOLATED CARGO_BAZEL_DEBUG","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Repinning / Updating Dependencies","id":"131","title":"Repinning / Updating Dependencies"},"132":{"body":"rules_rust manages versions of things like rustc. If you want to manually run upstream tooling configured at the versions, plugins and such that rules_rust has configured, rules_rust exposes these as targets in @rules_rust//tools/upstream_wrapper: % bazel query @rules_rust//tools/upstream_wrapper\n@rules_rust//tools/upstream_wrapper:cargo\n@rules_rust//tools/upstream_wrapper:cargo_clippy\n@rules_rust//tools/upstream_wrapper:rustc\n@rules_rust//tools/upstream_wrapper:rustfmt You can run them via bazel run, e.g. bazel run @rules_rust//tools/upstream_wrapper:cargo -- check.","breadcrumbs":"Upstream Tooling » Upstream Tooling","id":"132","title":"Upstream Tooling"},"133":{"body":"Bazel rules for interfacing with other rules and integrations with popular 3rd party tools.","breadcrumbs":"Extensions » Extensions","id":"133","title":"Extensions"},"134":{"body":"The extension rules are released with each release of rules_rust (core) which can be found on the GitHub Releases page . We recommend using the latest release from that page.","breadcrumbs":"Extensions » Setup","id":"134","title":"Setup"},"135":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust extensions in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust_{EXTENSION}\", version = \"{VERSION}\") Don't forget to substitute in your desired release's version number and {EXTENSION} with the name of the desired extension. E.g.: bazel_dep(name = \"rules_rust_bindgen\", version = \"0.55.0\")","breadcrumbs":"Extensions » Bzlmod","id":"135","title":"Bzlmod"},"136":{"body":"To use rules_rust extensions in a project using a WORKSPACE file, add the following to your WORKSPACE file to add the external repositories for the Rust toolchain: load(\"@bazel_tools//tools/build_defs/repo:http.bzl\", \"http_archive\") # To find additional information on this release or newer ones visit:\n# https://github.com/bazelbuild/rules_rust/releases\nhttp_archive( name = \"rules_rust_{EXTENSION}\", # See releases page\n) # Refer to the documentation of the desired rules for how to load other necessary dependencies. Don't forget to substitute in your desired release's version number, integrity hash, and {EXTENSION} with the name of the desired extension.","breadcrumbs":"Extensions » WORKSPACE","id":"136","title":"WORKSPACE"},"137":{"body":"These rules are for using Bindgen to generate Rust bindings to C (and some C++) libraries.","breadcrumbs":"Extensions » bindgen » rules_rust_bindgen","id":"137","title":"rules_rust_bindgen"},"138":{"body":"rust_bindgen rust_bindgen_library rust_bindgen_toolchain","breadcrumbs":"Extensions » bindgen » Rules","id":"138","title":"Rules"},"139":{"body":"To use the Rust bindgen rules, add the following to your WORKSPACE file to add the external repositories for the Rust bindgen toolchain (in addition to the rust rules setup ): load(\"@rules_rust_bindgen//:repositories.bzl\", \"rust_bindgen_dependencies\", \"rust_bindgen_register_toolchains\") rust_bindgen_dependencies() rust_bindgen_register_toolchains() load(\"@rules_rust_bindgen//:transitive_repositories.bzl\", \"rust_bindgen_transitive_dependencies\") rust_bindgen_transitive_dependencies() Bindgen aims to be as hermetic as possible so will end up building libclang from llvm-project from source. If this is found to be undesirable then no Bindgen related calls should be added to your WORKSPACE and instead users should define their own repositories using something akin to crate_universe and define their own toolchains following the instructions for rust_bindgen_toolchain .","breadcrumbs":"Extensions » bindgen » Setup","id":"139","title":"Setup"},"14":{"body":"extra_rustc_flag(name) Add additional rustc_flag from the command line with --@rules_rust//rust/settings:extra_rustc_flag. Multiple uses are accumulated and appended after the extra_rustc_flags. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flag","id":"14","title":"extra_rustc_flag"},"140":{"body":"rust_bindgen(name, bindgen_flags, cc_lib, clang_flags, header, merge_cc_lib_objects_into_rlib, wrap_static_fns) Generates a rust source file from a cc_library and a header. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. List of strings optional [] cc_lib The cc_library that contains the .h file. This is used to find the transitive includes. Label required clang_flags Flags to pass directly to the clang executable. List of strings optional [] header The .h file to generate bindings for. Label required merge_cc_lib_objects_into_rlib When True, objects from cc_lib will be copied into the rlib archive produced by the rust_library that depends on this rust_bindgen rule (using BuildInfo provider) Boolean optional True wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains). Boolean optional False","breadcrumbs":"Extensions » bindgen » rust_bindgen","id":"140","title":"rust_bindgen"},"141":{"body":"rust_bindgen_toolchain(name, bindgen, clang, default_rustfmt, libclang, libstdcxx) The tools required for the rust_bindgen rule. This rule depends on the bindgen binary crate, and it in turn depends on both a clang binary and the clang library. To obtain these dependencies, rust_bindgen_dependencies imports bindgen and its dependencies. load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( name = \"bindgen_toolchain_impl\", bindgen = \"//my/rust:bindgen\", clang = \"//my/clang:clang\", libclang = \"//my/clang:libclang.so\", libstdcxx = \"//my/cpp:libstdc++\",\n) toolchain( name = \"bindgen_toolchain\", toolchain = \"bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_bindgen//:toolchain_type\",\n) This toolchain will then need to be registered in the current WORKSPACE. For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a bindgen executable. Label optional None clang The label of a clang executable. Label optional None default_rustfmt If set, rust_bindgen targets will always format generated sources with rustfmt. Boolean optional True libclang A cc_library that provides bindgen's runtime dependency on libclang. Label optional None libstdcxx A cc_library that satisfies libclang's libstdc++ dependency. This is used to make the execution of clang hermetic. If None, system libraries will be used instead. Label optional None","breadcrumbs":"Extensions » bindgen » rust_bindgen_toolchain","id":"141","title":"rust_bindgen_toolchain"},"142":{"body":"rust_bindgen_library(name, header, cc_lib, bindgen_flags, bindgen_features, clang_flags, wrap_static_fns, kwargs) Generates a rust source file for header, and builds a rust_library. Arguments are the same as rust_bindgen, and kwargs are passed directly to rust_library. PARAMETERS Name Description Default Value name A unique name for this target. none header The label of the .h file to generate bindings for. none cc_lib The label of the cc_library that contains the .h file. This is used to find the transitive includes. none bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. None bindgen_features The features attribute for the rust_bindgen target. None clang_flags Flags to pass directly to the clang executable. None wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains\", False kwargs Arguments to forward to the underlying rust_library rule. none","breadcrumbs":"Extensions » bindgen » rust_bindgen_library","id":"142","title":"rust_bindgen_library"},"143":{"body":"Bazel rules for mdBook .","breadcrumbs":"Extensions » mdbook » rules_rust_mdbook","id":"143","title":"rules_rust_mdbook"},"144":{"body":"mdbook mdbook_server mdbook_toolchain","breadcrumbs":"Extensions » mdbook » Rules","id":"144","title":"Rules"},"145":{"body":"","breadcrumbs":"Extensions » mdbook » Setup","id":"145","title":"Setup"},"146":{"body":"bazel_dep(name = \"rules_rust_mdbook\", version = \"{SEE_RELEASE_NOTES}\")","breadcrumbs":"Extensions » mdbook » bzlmod","id":"146","title":"bzlmod"},"147":{"body":"load(\"@rules_rust_mdbook//:repositories.bzl\", \"mdbook_register_toolchains\", \"rules_mdbook_dependencies\") rules_mdbook_dependencies() mdbook_register_toolchains() load(\"@rules_rust_mdbook//:repositories_transitive.bzl\", \"rules_mdbook_transitive_deps\") rules_mdbook_transitive_deps()","breadcrumbs":"Extensions » mdbook » WORKSPACE","id":"147","title":"WORKSPACE"},"148":{"body":"mdbook(name, srcs, book, plugins) Rules to create book from markdown files using mdBook. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required srcs All inputs to the book. List of labels optional [] book The book.toml file. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook","id":"148","title":"mdbook"},"149":{"body":"mdbook_server(name, book, hostname, port) Spawn an mdbook server for a given mdbook target. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required book The mdbook target to serve. Label required hostname The default hostname to use (Can be overridden on the command line). String optional \"localhost\" port The default port to use (Can be overridden on the command line). String optional \"3000\"","breadcrumbs":"Extensions » mdbook » mdbook_server","id":"149","title":"mdbook_server"},"15":{"body":"extra_rustc_flags(name) Add additional rustc_flags from the command line with --@rules_rust//rust/settings:extra_rustc_flags. This flag should only be used for flags that need to be applied across the entire build. For options that apply to individual crates, use the rustc_flags attribute on the individual crate's rule instead. NOTE: These flags not applied to the exec configuration (proc-macros, cargo_build_script, etc); use --@rules_rust//rust/settings:extra_exec_rustc_flags to apply flags to the exec configuration. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flags","id":"15","title":"extra_rustc_flags"},"150":{"body":"mdbook_toolchain(name, mdbook, plugins) A mdBook toolchain. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required mdbook A mdBook binary. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook_toolchain","id":"150","title":"mdbook_toolchain"},"151":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using Prost and Tonic","breadcrumbs":"Extensions » prost » rules_rust_prost","id":"151","title":"rules_rust_prost"},"152":{"body":"rust_prost_library rust_prost_toolchain","breadcrumbs":"Extensions » prost » Rules","id":"152","title":"Rules"},"153":{"body":"load(\"@rules_rust//proto/prost:repositories.bzl\", \"rust_prost_dependencies\") rust_prost_dependencies() load(\"@rules_rust//proto/prost:transitive_repositories.bzl\", \"rust_prost_transitive_repositories\") rust_prost_transitive_repositories() The prost and tonic rules do not specify a default toolchain in order to avoid mismatched dependency issues. To setup the prost and tonic toolchain, please see the section Customizing prost and tonic Dependencies . For additional information about Bazel toolchains, see here . Customizing prost and tonic Dependencies These rules depend on the prost and tonic dependencies. To setup the necessary toolchain for these rules, you must define a toolchain with the prost , prost-types , tonic , protoc-gen-prost , and protoc-gen-tonic crates as well as the protoc binary. To get access to these crates, you can use the crate_universe repository rules. For example: load(\"//crate_universe:defs.bzl\", \"crate\", \"crates_repository\") crates_repository( name = \"crates_io\", annotations = { \"protoc-gen-prost\": [crate.annotation( gen_binaries = [\"protoc-gen-prost\"], patch_args = [ \"-p1\", ], patches = [ # Note: You will need to use this patch until a version greater than `0.2.2` of # `protoc-gen-prost` is released. \"@rules_rust//proto/prost/private/3rdparty/patches:protoc-gen-prost.patch\", ], )], \"protoc-gen-tonic\": [crate.annotation( gen_binaries = [\"protoc-gen-tonic\"], )], }, cargo_lockfile = \"Cargo.Bazel.lock\", mode = \"remote\", packages = { \"prost\": crate.spec( version = \"0\", ), \"prost-types\": crate.spec( version = \"0\", ), \"protoc-gen-prost\": crate.spec( version = \"0\", ), \"protoc-gen-tonic\": crate.spec( version = \"0\", ), \"tonic\": crate.spec( version = \"0\", ), }, repository_name = \"rules_rust_prost\", tags = [\"manual\"],\n) You can then define a toolchain with the rust_prost_toolchain rule which uses the crates defined above. For example: load(\"@rules_rust//proto/prost:defs.bzl\", \"rust_prost_toolchain\")\nload(\"@rules_rust//rust:defs.bzl\", \"rust_library_group\") rust_library_group( name = \"prost_runtime\", deps = [ \"@crates_io//:prost\", ],\n) rust_library_group( name = \"tonic_runtime\", deps = [ \":prost_runtime\", \"@crates_io//:tonic\", ],\n) rust_prost_toolchain( name = \"prost_toolchain_impl\", prost_plugin = \"@crates_io//:protoc-gen-prost__protoc-gen-prost\", prost_runtime = \":prost_runtime\", prost_types = \"@crates_io//:prost-types\", proto_compiler = \"@com_google_protobuf//:protoc\", tonic_plugin = \"@crates_io//:protoc-gen-tonic__protoc-gen-tonic\", tonic_runtime = \":tonic_runtime\",\n) toolchain( name = \"prost_toolchain\", toolchain = \"prost_toolchain_impl\", toolchain_type = \"@rules_rust//proto/prost:toolchain_type\",\n) Lastly, you must register the toolchain in your WORKSPACE file. For example: register_toolchains(\"//toolchains:prost_toolchain\")","breadcrumbs":"Extensions » prost » Setup","id":"153","title":"Setup"},"154":{"body":"rust_prost_library(name, proto) A rule for generating a Rust library using Prost. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required proto A proto_library target for which to generate Rust gencode. Label required","breadcrumbs":"Extensions » prost » rust_prost_library","id":"154","title":"rust_prost_library"},"155":{"body":"rust_prost_toolchain(name, include_transitive_deps, prost_opts, prost_plugin, prost_plugin_flag, prost_runtime, prost_types, proto_compiler, tonic_opts, tonic_plugin, tonic_plugin_flag, tonic_runtime) Rust Prost toolchain rule. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required include_transitive_deps Whether to include transitive dependencies. If set to True, all transitive dependencies will directly accessible by the dependent crate. Boolean optional False prost_opts Additional options to add to Prost. List of strings optional [] prost_plugin Additional plugins to add to Prost. Label required prost_plugin_flag Prost plugin flag format. (e.g. --plugin=protoc-gen-prost=%s) String optional \"--plugin=protoc-gen-prost=%s\" prost_runtime The Prost runtime crates to use. Label required prost_types The Prost types crates to use. Label required proto_compiler The protoc compiler to use. Note that this attribute is deprecated - prefer to use --incompatible_enable_proto_toolchain_resolution. Label optional None tonic_opts Additional options to add to Tonic. List of strings optional [] tonic_plugin Additional plugins to add to Tonic. Label optional None tonic_plugin_flag Tonic plugin flag format. (e.g. --plugin=protoc-gen-tonic=%s)) String optional \"--plugin=protoc-gen-tonic=%s\" tonic_runtime The Tonic runtime crates to use. Label optional None","breadcrumbs":"Extensions » prost » rust_prost_toolchain","id":"155","title":"rust_prost_toolchain"},"156":{"body":"rust_prost_transform(name, deps, srcs, prost_opts, tonic_opts) A rule for transforming the outputs of ProstGenProto actions. This rule is used by adding it to the data attribute of proto_library targets. E.g. load(\"@rules_proto//proto:defs.bzl\", \"proto_library\")\nload(\"@rules_rust_prost//:defs.bzl\", \"rust_prost_library\", \"rust_prost_transform\") rust_prost_transform( name = \"a_transform\", srcs = [ \"a_src.rs\", ],\n) proto_library( name = \"a_proto\", srcs = [ \"a.proto\", ], data = [ \":transform\", ],\n) rust_prost_library( name = \"a_rs_proto\", proto = \":a_proto\",\n) The rust_prost_library will spawn an action on the a_proto target which consumes the a_transform rule to provide a means of granularly modifying a proto library for ProstGenProto actions with minimal impact to other consumers. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Additional dependencies to add to the compiled crate. List of labels optional [] srcs Additional source files to include in generated Prost source code. List of labels optional [] prost_opts Additional options to add to Prost. List of strings optional [] tonic_opts Additional options to add to Tonic. List of strings optional []","breadcrumbs":"Extensions » prost » rust_prost_transform","id":"156","title":"rust_prost_transform"},"157":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using rust-protobuf .","breadcrumbs":"Extensions » protobuf » rules_rust_protobuf","id":"157","title":"rules_rust_protobuf"},"158":{"body":"To use the Rust proto rules, add the following to your WORKSPACE file to add the external repositories for the Rust proto toolchain (in addition to the rust rules setup ): load(\"@rules_rust//proto/protobuf:repositories.bzl\", \"rust_proto_protobuf_dependencies\", \"rust_proto_protobuf_register_toolchains\") rust_proto_protobuf_dependencies() rust_proto_protobuf_register_toolchains() load(\"@rules_rust//proto/protobuf:transitive_repositories.bzl\", \"rust_proto_protobuf_transitive_repositories\") rust_proto_protobuf_transitive_repositories() This will load the required dependencies for the rust-protobuf rules. It will also register a default toolchain for the rust_proto_library and rust_grpc_library rules. To customize the rust_proto_library and rust_grpc_library toolchain, please see the section Customizing rust-protobuf Dependencies . For additional information about Bazel toolchains, see here . Customizing rust-protobuf Dependencies These rules depend on the protobuf and the grpc crates in addition to the protobuf compiler . To obtain these crates, rust_proto_repositories imports the given crates using BUILD files generated with crate_universe . If you want to either change the protobuf and gRPC rust compilers, or to simply use crate_universe in a more complex scenario (with more dependencies), you must redefine those dependencies. To do this, once you've imported the needed dependencies (see our @rules_rust//proto/protobuf/3rdparty/BUILD.bazel file to see the default dependencies), you need to create your own toolchain. To do so you can create a BUILD file with your toolchain definition, for example: load(\"@rules_rust//proto:toolchain.bzl\", \"rust_proto_toolchain\") rust_proto_toolchain( name = \"proto-toolchain-impl\", # Path to the protobuf compiler. protoc = \"@com_google_protobuf//:protoc\", # Protobuf compiler plugin to generate rust gRPC stubs. grpc_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust_grpc\", # Protobuf compiler plugin to generate rust protobuf stubs. proto_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust\",\n) toolchain( name = \"proto-toolchain\", toolchain = \":proto-toolchain-impl\", toolchain_type = \"@rules_rust//proto/protobuf:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:proto-toolchain\") Finally, you might want to set the rust_deps attribute in rust_proto_library and rust_grpc_library to change the compile-time dependencies: rust_proto_library( ... rust_deps = [\"//3rdparty/crates:protobuf\"], ...\n) rust_grpc_library( ... rust_deps = [ \"//3rdparty/crates:protobuf\", \"//3rdparty/crates:grpc\", \"//3rdparty/crates:tls_api\", \"//3rdparty/crates:tls_api_stub\", ], ...\n) Note : Ideally, we would inject those dependencies from the toolchain, but due to bazelbuild/bazel#6889 all dependencies added via the toolchain ends-up being in the wrong configuration.","breadcrumbs":"Extensions » protobuf » Setup","id":"158","title":"Setup"},"159":{"body":"rust_grpc_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys suitable for gRPC. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_grpc_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_grpc_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_service\", srcs = [\"my_service.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding gRPC stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_grpc_library","id":"159","title":"rust_grpc_library"},"16":{"body":"rust_binary(name, deps, srcs, data, aliases, alwayslink, binary_name, compile_data, crate_features, crate_name, crate_root, crate_type, edition, env, experimental_use_cc_common_link, linker_script, malloc, out_binary, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust binary crate. Example: Suppose you have the following directory structure for a Rust project with a library crate, hello_lib, and a binary crate, hello_world that uses the hello_lib library: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_world/ BUILD src/ main.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) hello_world/src/main.rs: extern crate hello_lib; fn main() { let hello = hello_lib::Greeter::new(\"Hello\"); hello.greet(\"world\");\n} hello_world/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_binary\") rust_binary( name = \"hello_world\", srcs = [\"src/main.rs\"], deps = [\"//hello_lib\"],\n) Build and run hello_world: $ bazel run //hello_world\nINFO: Found 1 target...\nTarget //examples/rust/hello_world:hello_world up-to-date:\nbazel-bin/examples/rust/hello_world/hello_world\nINFO: Elapsed time: 1.308s, Critical Path: 1.22s INFO: Running command line: bazel-bin/examples/rust/hello_world/hello_world\nHello world On Windows, a PDB file containing debugging information is available under the key pdb_file in OutputGroupInfo. Similarly on macOS, a dSYM folder is available under the key dsym_folder in OutputGroupInfo. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False binary_name Override the resulting binary file name. By default, the binary file will be named using the name attribute on this rule, however sometimes that is not deseriable. String optional \"\" compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None crate_type Crate type that will be passed to rustc to be used for building this crate.This option is a temporary workaround and should be used only when building for WebAssembly targets (//rust/platform:wasi and //rust/platform:wasm). String optional \"bin\" edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the target is executed by bazel run. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution.Execpath returns absolute path, and in order to be able to construct the absolute path we need to wrap the test binary in a launcher. Using a launcher comes with complications, such as more complicated debugger attachment. Dictionary: String -> String optional {} experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 linker_script Link script to forward into linker via rustc options. Label optional None malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" out_binary Force a target, regardless of it's crate_type, to always mark the file as executable. This attribute is only used to support wasm targets but is expected to be removed following a resolution to https://github.com/bazelbuild/rules_rust/issues/771. Boolean optional False platform Optional platform to transition the binary to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional -1 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_binary","id":"16","title":"rust_binary"},"160":{"body":"rust_proto_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_proto_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_proto_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_proto_binary\", srcs = [\"my_proto_binary.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_proto_library","id":"160","title":"rust_proto_library"},"161":{"body":"Bazel rules for generating wasm modules for Javascript using wasm-bindgen .","breadcrumbs":"Extensions » wasm_bindgen » rules_rust_wasm_bindgen","id":"161","title":"rules_rust_wasm_bindgen"},"162":{"body":"rust_wasm_bindgen rust_wasm_bindgen_toolchain","breadcrumbs":"Extensions » wasm_bindgen » Rules","id":"162","title":"Rules"},"163":{"body":"To begin using the wasm-bindgen rules, users can load the necessary dependencies in their workspace by adding the following to their WORKSPACE.bazel file. load(\"@rules_rust_wasm_bindgen//:repositories.bzl\", \"rust_wasm_bindgen_dependencies\", \"rust_wasm_bindgen_register_toolchains\") rust_wasm_bindgen_dependencies() rust_wasm_bindgen_register_toolchains() This should enable users to start using the rust_wasm_bindgen rule. However, it's common to want to control the version of wasm-bindgen in the workspace instead of relying on the one provided by rules_rust. In this case, users should avoid calling rust_wasm_bindgen_register_toolchains and instead use the rust_wasm_bindgen_toolchain rule to define their own toolchains to register in the workspace.","breadcrumbs":"Extensions » wasm_bindgen » Setup","id":"163","title":"Setup"},"164":{"body":"While it's recommended for users to mantain their own , in the @rules_rust_wasm_bindgen package there exists interface sub-packages for various Javascript Bazel rules. E.g. aspect_rules_js. The rules defined there are a more convenient way to use rust_wasm_bindgen with the associated javascript rules due to the inclusion of additional providers. Each directory contains a defs.bzl file that defines the different variants of rust_wasm_bindgen. (e.g. js_rust_wasm_bindgen for the rules_js submodule).","breadcrumbs":"Extensions » wasm_bindgen » Interfacing with Javascript rules","id":"164","title":"Interfacing with Javascript rules"},"165":{"body":"rust_wasm_bindgen(name, bindgen_flags, out_name, target, target_arch, wasm_file) Generates javascript and typescript bindings for a webassembly module using wasm-bindgen . An example of this rule in use can be seen at @rules_rust//examples/wasm ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the wasm-bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details. List of strings optional [] out_name Set a custom output filename (Without extension. Defaults to target name). String optional \"\" target The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details. String optional \"bundler\" target_arch The target architecture to use for the wasm-bindgen command line option. String optional \"wasm32\" wasm_file The .wasm file or crate to generate bindings for. Label required","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen","id":"165","title":"rust_wasm_bindgen"},"166":{"body":"rust_wasm_bindgen_toolchain(name, bindgen) The tools required for the rust_wasm_bindgen rule. In cases where users want to control or change the version of wasm-bindgen used by rust_wasm_bindgen , a unique toolchain can be created as in the example below: load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( bindgen = \"//3rdparty/crates:wasm_bindgen_cli__bin\",\n) toolchain( name = \"wasm_bindgen_toolchain\", toolchain = \"wasm_bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_wasm_bindgen//:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:wasm_bindgen_toolchain\") For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a wasm-bindgen-cli executable. Label optional None","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen_toolchain","id":"166","title":"rust_wasm_bindgen_toolchain"},"167":{"body":"RustWasmBindgenInfo(js, ts, wasm) Info about wasm-bindgen outputs. FIELDS Name Description js Depset[File]: The Javascript files produced by wasm-bindgen. ts Depset[File]: The Typescript files produced by wasm-bindgen. wasm File: The .wasm file generated by wasm-bindgen.","breadcrumbs":"Extensions » wasm_bindgen » RustWasmBindgenInfo","id":"167","title":"RustWasmBindgenInfo"},"17":{"body":"rust_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, disable_pipelining, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust library crate. Example: Suppose you have the following directory structure for a simple Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ greeter.rs lib.rs hello_lib/src/greeter.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/src/lib.rs: pub mod greeter; hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [ \"src/greeter.rs\", \"src/lib.rs\", ],\n) Build the library: $ bazel build //hello_lib\nINFO: Found 1 target...\nTarget //examples/rust/hello_lib:hello_lib up-to-date:\nbazel-bin/examples/rust/hello_lib/libhello_lib.rlib\nINFO: Elapsed time: 1.245s, Critical Path: 1.01s ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None disable_pipelining Disables pipelining for this rule if it is globally enabled. This will cause this rule to not produce a .rmeta file and all the dependent crates will instead use the .rlib file. Boolean optional False edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_library","id":"17","title":"rust_library"},"18":{"body":"rust_library_group(name, deps) Functions as an alias for a set of dependencies. Specifically, the following are equivalent: rust_library_group( name = \"crate_group\", deps = [ \":crate1\", \":crate2\", ],\n) rust_library( name = \"foobar\", deps = [\":crate_group\"], ...\n) and rust_library( name = \"foobar\", deps = [ \":crate1\", \":crate2\", ], ...\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Other dependencies to forward through this crate group. List of labels optional []","breadcrumbs":"Rules » rust » rust_library_group","id":"18","title":"rust_library_group"},"19":{"body":"rust_proc_macro(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust proc-macro crate. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_proc_macro","id":"19","title":"rust_proc_macro"},"2":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust\", version = \"0.48.0\") Don't forget to substitute in your desired release's version number.","breadcrumbs":"Introduction » Bzlmod","id":"2","title":"Bzlmod"},"20":{"body":"rust_shared_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust shared library. This shared library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce a shared library that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the shared library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_shared_library","id":"20","title":"rust_shared_library"},"21":{"body":"rust_static_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust static library. This static library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce an archive that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" platform Optional platform to transition the static library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_static_library","id":"21","title":"rust_static_library"},"22":{"body":"rust_test(name, deps, srcs, data, aliases, alwayslink, compile_data, crate, crate_features, crate_name, crate_root, edition, env, env_inherit, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, use_libtest_harness, version) Builds a Rust test crate. Examples: Suppose you have the following directory structure for a Rust library crate with unit test code in the library sources: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) -> String { format!(\"{} {}\", &self.greeting, thing) }\n} #[cfg(test)]\nmod test { use super::Greeter; #[test] fn test_greeting() { let hello = Greeter::new(\"Hi\"); assert_eq!(\"Hi Rust\", hello.greet(\"Rust\")); }\n} To build and run the tests, simply add a rust_test rule with no srcs and only depends on the hello_lib rust_library target via the crate attribute: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"hello_lib_test\", crate = \":hello_lib\", # You may add other deps that are specific to the test configuration deps = [\"//some/dev/dep\"],\n) Run the test with bazel test //hello_lib:hello_lib_test.","breadcrumbs":"Rules » rust » rust_test","id":"22","title":"rust_test"},"23":{"body":"Integration tests that live in the tests directory , they are essentially built as separate crates. Suppose you have the following directory structure where greeting.rs is an integration test for the hello_lib library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs tests/ greeting.rs hello_lib/tests/greeting.rs: extern crate hello_lib; use hello_lib; #[test]\nfn test_greeting() { let hello = greeter::Greeter::new(\"Hello\"); assert_eq!(\"Hello world\", hello.greeting(\"world\"));\n} To build the greeting.rs integration test, simply add a rust_test target with greeting.rs in srcs and a dependency on the hello_lib target: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"greeting_test\", srcs = [\"tests/greeting.rs\"], deps = [\":hello_lib\"],\n) Run the test with bazel test //hello_lib:greeting_test. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate Target inline tests declared in the given crateThese tests are typically those that would be held out under #[cfg(test)] declarations. Label optional None crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the test is executed by bazel test. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution. Dictionary: String -> String optional {} env_inherit Specifies additional environment variables to inherit from the external environment when the test is executed by bazel test. List of strings optional [] experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the test to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 use_libtest_harness Whether to use libtest. For targets using this flag, individual tests can be run by using the --test_arg flag. E.g. bazel test //src:rust_test --test_arg=foo::test::test_fn. Boolean optional True version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » Example: test directory","id":"23","title":"Example: test directory"},"24":{"body":"rust_test_suite(name, srcs, shared_srcs, kwargs) A rule for creating a test suite for a set of rust_test targets. This rule can be used for setting up typical rust integration tests . Given the following directory structure: [crate]/ BUILD.bazel src/ lib.rs main.rs tests/ integrated_test_a.rs integrated_test_b.rs integrated_test_c.rs patterns/ fibonacci_test.rs helpers/ mod.rs The rule can be used to generate rust_test targets for each source file under tests and a test_suite which encapsulates all tests. load(\"//rust:defs.bzl\", \"rust_binary\", \"rust_library\", \"rust_test_suite\") rust_library( name = \"math_lib\", srcs = [\"src/lib.rs\"],\n) rust_binary( name = \"math_bin\", srcs = [\"src/main.rs\"],\n) rust_test_suite( name = \"integrated_tests_suite\", srcs = glob([\"tests/**\"]), shared_srcs=glob([\"tests/helpers/**\"]), deps = [\":math_lib\"],\n) PARAMETERS Name Description Default Value name The name of the test_suite. none srcs All test sources, typically glob([\"tests/**/*.rs\"]). none shared_srcs Optional argument for sources shared among tests, typically helper functions. [] kwargs Additional keyword arguments for the underyling rust_test targets. The tags argument is also passed to the generated test_suite target. none","breadcrumbs":"Rules » rust » rust_test_suite","id":"24","title":"rust_test_suite"},"25":{"body":"rust_doc rust_doc_test","breadcrumbs":"Rules » rustdoc » Rust Doc","id":"25","title":"Rust Doc"},"26":{"body":"rust_doc(name, crate, html_after_content, html_before_content, html_in_header, markdown_css, rustc_flags, rustdoc_flags) Generates code documentation. Example: Suppose you have the following directory structure for a Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs To build rustdoc documentation for the hello_lib crate, define a rust_doc rule that depends on the the hello_lib rust_library target: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_doc\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_doc( name = \"hello_lib_doc\", crate = \":hello_lib\",\n) Running bazel build //hello_lib:hello_lib_doc will build a zip file containing the documentation for the hello_lib library crate generated by rustdoc. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required crate The label of the target to generate code documentation for.rust_doc can generate HTML code documentation for the source files of rust_library or rust_binary targets. Label required html_after_content File to add in , after content. Label optional None html_before_content File to add in , before content. Label optional None html_in_header File to add to . Label optional None markdown_css CSS files to include via :' that takes a single label parameter 'actual'. See '@crate_index//:alias_rules.bzl' for an example. \"alias\" default_package_name The default package name to use in the rendered macros. This affects the auto package detection of things like all_crate_deps. None generate_target_compatible_with Whether to generate target_compatible_with annotations on the generated BUILD files. This catches a target_triplebeing targeted that isn't declared in supported_platform_triples. True platforms_template The base template to use for platform names. See platforms documentation . The available format keys are [{triple}]. \"@rules_rust//rust/platform:{triple}\" regen_command An optional command to demonstrate how generated files should be regenerated. None vendor_mode An optional configuration for rendirng content to be rendered into repositories. None generate_rules_license_metadata Whether to generate rules license metedata False RETURNS string: A json encoded struct to match the Rust config::RenderConfig struct","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » render_config","id":"128","title":"render_config"},"129":{"body":"splicing_config(resolver_version) Various settings used to configure Cargo manifest splicing behavior. PARAMETERS Name Description Default Value resolver_version The resolver version to use in generated Cargo manifests. This flag is only used when splicing a manifest from direct package definitions. See crates_repository::packages. \"2\" RETURNS str: A json encoded string of the parameters provided","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » splicing_config","id":"129","title":"splicing_config"},"13":{"body":"error_format(name) Change the --error-format flag from the command line with --@rules_rust//rust/settings:error_format. See rustc documentation for valid values. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » error_format","id":"13","title":"error_format"},"130":{"body":"crates_repository(name, annotations, cargo_config, cargo_lockfile, compressed_windows_toolchain_names, generate_binaries, generate_build_scripts, generate_target_compatible_with, generator, generator_sha256s, generator_urls, isolated, lockfile, manifests, packages, quiet, render_config, repin_instructions, repo_mapping, rust_toolchain_cargo_template, rust_toolchain_rustc_template, rust_version, splicing_config, supported_platform_triples) A rule for defining and downloading Rust dependencies (crates). This rule handles all the same workflows crate_universe rules do. Environment Variables: variable usage CARGO_BAZEL_GENERATOR_SHA256 The sha256 checksum of the file located at CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_URL The URL of a cargo-bazel binary. This variable takes precedence over attributes and can use file:// for local paths CARGO_BAZEL_ISOLATED An authorative flag as to whether or not the CARGO_HOME environment variable should be isolated from the host configuration CARGO_BAZEL_REPIN An indicator that the dependencies represented by the rule should be regenerated. REPIN may also be used. See Repinning / Updating Dependencies for more details. CARGO_BAZEL_REPIN_ONLY A comma-delimited allowlist for rules to execute repinning. Can be useful if multiple instances of the repository rule are used in a Bazel workspace, but repinning should be limited to one of them. Example: Given the following workspace structure: [workspace]/ WORKSPACE.bazel BUILD.bazel Cargo.toml Cargo.Bazel.lock src/ main.rs The following is something that'd be found in the WORKSPACE file: load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_repository\", \"crate\") crates_repository( name = \"crate_index\", annotations = { \"rand\": [crate.annotation( default_features = False, features = [\"small_rng\"], )], }, cargo_lockfile = \"//:Cargo.Bazel.lock\", lockfile = \"//:cargo-bazel-lock.json\", manifests = [\"//:Cargo.toml\"], # Should match the version represented by the currently registered `rust_toolchain`. rust_version = \"1.60.0\",\n) The above will create an external repository which contains aliases and macros for accessing Rust targets found in the dependency graph defined by the given manifests. NOTE : The cargo_lockfile and lockfile must be manually created. The rule unfortunately does not yet create it on its own. When initially setting up this rule, an empty file should be created and then populated by repinning dependencies.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crates_repository","id":"130","title":"crates_repository"},"131":{"body":"Dependency syncing and updating is done in the repository rule which means it's done during the analysis phase of builds. As mentioned in the environments variable table above, the CARGO_BAZEL_REPIN (or REPIN) environment variables can be used to force the rule to update dependencies and potentially render a new lockfile. Given an instance of this repository rule named crate_index, the easiest way to repin dependencies is to run: CARGO_BAZEL_REPIN=1 bazel sync --only=crate_index This will result in all dependencies being updated for a project. The CARGO_BAZEL_REPIN environment variable can also be used to customize how dependencies are updated. The following table shows translations from environment variable values to the equivilant cargo update command that is called behind the scenes to update dependencies. Value Cargo command Any of [true, 1, yes, on, workspace] cargo update --workspace Any of [full, eager, all] cargo update package_name cargo upgrade --package package_name package_name@1.2.3 cargo upgrade --package package_name@1.2.3 package_name@1.2.3=4.5.6 cargo upgrade --package package_name@1.2.3 --precise=4.5.6 If the crates_repository is used multiple times in the same Bazel workspace (e.g. for multiple independent Rust workspaces), it may additionally be useful to use the CARGO_BAZEL_REPIN_ONLY environment variable, which limits execution of the repinning to one or multiple instances of the crates_repository rule via a comma-delimited allowlist: CARGO_BAZEL_REPIN=1 CARGO_BAZEL_REPIN_ONLY=crate_index bazel sync --only=crate_index ATTRIBUTES Name Description Type Mandatory Default name A unique name for this repository. Name required annotations Extra settings to apply to crates. See crate.annotation . Dictionary: String -> List of strings optional {} cargo_config A Cargo configuration file Label optional None cargo_lockfile The path used to store the crates_repository specific Cargo.lock file. In the case that your crates_repository corresponds directly with an existing Cargo.toml file which has a paired Cargo.lock file, that Cargo.lock file should be used here, which will keep the versions used by cargo and bazel in sync. Label required compressed_windows_toolchain_names Wether or not the toolchain names of windows toolchains are expected to be in a compressed format. Boolean optional True generate_binaries Whether to generate rust_binary targets for all the binary crates in every package. By default only the rust_library targets are generated. Boolean optional False generate_build_scripts Whether or not to generate cargo build scripts by default. Boolean optional True generate_target_compatible_with DEPRECATED: Moved to render_config. Boolean optional True generator The absolute label of a generator. Eg. @cargo_bazel_bootstrap//:cargo-bazel. This is typically used when bootstrapping String optional \"\" generator_sha256s Dictionary of host_triple -> sha256 for a cargo-bazel binary. Dictionary: String -> String optional {} generator_urls URL template from which to download the cargo-bazel binary. {host_triple} and will be filled in according to the host platform. Dictionary: String -> String optional {} isolated If true, CARGO_HOME will be overwritten to a directory within the generated repository in order to prevent other uses of Cargo from impacting having any effect on the generated targets produced by this rule. For users who either have multiple crate_repository definitions in a WORKSPACE or rapidly re-pin dependencies, setting this to false may improve build times. This variable is also controled by CARGO_BAZEL_ISOLATED environment variable. Boolean optional True lockfile The path to a file to use for reproducible renderings. If set, this file must exist within the workspace (but can be empty) before this rule will work. Label optional None manifests A list of Cargo manifests (Cargo.toml files). List of labels optional [] packages A set of crates (packages) specifications to depend on. See crate.spec . Dictionary: String -> String optional {} quiet If stdout and stderr should not be printed to the terminal. Boolean optional True render_config The configuration flags to use for rendering. Use //crate_universe:defs.bzl\\%render_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" repin_instructions Instructions to re-pin the repository if required. Many people have wrapper scripts for keeping dependencies up to date, and would like to point users to that instead of the default. String optional \"\" repo_mapping In WORKSPACE context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.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).This attribute is not supported in MODULE.bazel context (when invoking a repository rule inside a module extension's implementation function). Dictionary: String -> String optional rust_toolchain_cargo_template The template to use for finding the host cargo binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'rustc.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_toolchain_rustc_template The template to use for finding the host rustc binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'cargo.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_version The version of Rust the currently registered toolchain is using. Eg. 1.56.0, or nightly/2021-09-08 String optional \"1.83.0\" splicing_config The configuration flags to use for splicing Cargo maniests. Use //crate_universe:defs.bzl\\%rsplicing_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" supported_platform_triples A set of all platform triples to consider when generating dependencies. List of strings optional [\"aarch64-apple-darwin\", \"aarch64-apple-ios\", \"aarch64-apple-ios-sim\", \"aarch64-linux-android\", \"aarch64-pc-windows-msvc\", \"aarch64-unknown-fuchsia\", \"aarch64-unknown-linux-gnu\", \"aarch64-unknown-nixos-gnu\", \"aarch64-unknown-nto-qnx710\", \"arm-unknown-linux-gnueabi\", \"armv7-linux-androideabi\", \"armv7-unknown-linux-gnueabi\", \"i686-apple-darwin\", \"i686-linux-android\", \"i686-pc-windows-msvc\", \"i686-unknown-freebsd\", \"i686-unknown-linux-gnu\", \"powerpc-unknown-linux-gnu\", \"riscv32imc-unknown-none-elf\", \"riscv64gc-unknown-none-elf\", \"s390x-unknown-linux-gnu\", \"thumbv7em-none-eabi\", \"thumbv8m.main-none-eabi\", \"wasm32-unknown-unknown\", \"wasm32-wasip1\", \"x86_64-apple-darwin\", \"x86_64-apple-ios\", \"x86_64-linux-android\", \"x86_64-pc-windows-msvc\", \"x86_64-unknown-freebsd\", \"x86_64-unknown-fuchsia\", \"x86_64-unknown-linux-gnu\", \"x86_64-unknown-nixos-gnu\", \"x86_64-unknown-none\"] ENVIRONMENT VARIABLES This repository rule depends on the following environment variables: CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_SHA256 CARGO_BAZEL_REPIN REPIN CARGO_BAZEL_REPIN_ONLY CARGO_BAZEL_ISOLATED CARGO_BAZEL_DEBUG","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Repinning / Updating Dependencies","id":"131","title":"Repinning / Updating Dependencies"},"132":{"body":"rules_rust manages versions of things like rustc. If you want to manually run upstream tooling configured at the versions, plugins and such that rules_rust has configured, rules_rust exposes these as targets in @rules_rust//tools/upstream_wrapper: % bazel query @rules_rust//tools/upstream_wrapper\n@rules_rust//tools/upstream_wrapper:cargo\n@rules_rust//tools/upstream_wrapper:cargo_clippy\n@rules_rust//tools/upstream_wrapper:rustc\n@rules_rust//tools/upstream_wrapper:rustfmt You can run them via bazel run, e.g. bazel run @rules_rust//tools/upstream_wrapper:cargo -- check.","breadcrumbs":"Upstream Tooling » Upstream Tooling","id":"132","title":"Upstream Tooling"},"133":{"body":"Bazel rules for interfacing with other rules and integrations with popular 3rd party tools.","breadcrumbs":"Extensions » Extensions","id":"133","title":"Extensions"},"134":{"body":"The extension rules are released with each release of rules_rust (core) which can be found on the GitHub Releases page . We recommend using the latest release from that page.","breadcrumbs":"Extensions » Setup","id":"134","title":"Setup"},"135":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust extensions in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust_{EXTENSION}\", version = \"{VERSION}\") Don't forget to substitute in your desired release's version number and {EXTENSION} with the name of the desired extension. E.g.: bazel_dep(name = \"rules_rust_bindgen\", version = \"0.55.0\")","breadcrumbs":"Extensions » Bzlmod","id":"135","title":"Bzlmod"},"136":{"body":"To use rules_rust extensions in a project using a WORKSPACE file, add the following to your WORKSPACE file to add the external repositories for the Rust toolchain: load(\"@bazel_tools//tools/build_defs/repo:http.bzl\", \"http_archive\") # To find additional information on this release or newer ones visit:\n# https://github.com/bazelbuild/rules_rust/releases\nhttp_archive( name = \"rules_rust_{EXTENSION}\", # See releases page\n) # Refer to the documentation of the desired rules for how to load other necessary dependencies. Don't forget to substitute in your desired release's version number, integrity hash, and {EXTENSION} with the name of the desired extension.","breadcrumbs":"Extensions » WORKSPACE","id":"136","title":"WORKSPACE"},"137":{"body":"These rules are for using Bindgen to generate Rust bindings to C (and some C++) libraries.","breadcrumbs":"Extensions » bindgen » rules_rust_bindgen","id":"137","title":"rules_rust_bindgen"},"138":{"body":"rust_bindgen rust_bindgen_library rust_bindgen_toolchain","breadcrumbs":"Extensions » bindgen » Rules","id":"138","title":"Rules"},"139":{"body":"To use the Rust bindgen rules, add the following to your WORKSPACE file to add the external repositories for the Rust bindgen toolchain (in addition to the rust rules setup ): load(\"@rules_rust_bindgen//:repositories.bzl\", \"rust_bindgen_dependencies\", \"rust_bindgen_register_toolchains\") rust_bindgen_dependencies() rust_bindgen_register_toolchains() load(\"@rules_rust_bindgen//:transitive_repositories.bzl\", \"rust_bindgen_transitive_dependencies\") rust_bindgen_transitive_dependencies() Bindgen aims to be as hermetic as possible so will end up building libclang from llvm-project from source. If this is found to be undesirable then no Bindgen related calls should be added to your WORKSPACE and instead users should define their own repositories using something akin to crate_universe and define their own toolchains following the instructions for rust_bindgen_toolchain .","breadcrumbs":"Extensions » bindgen » Setup","id":"139","title":"Setup"},"14":{"body":"extra_rustc_flag(name) Add additional rustc_flag from the command line with --@rules_rust//rust/settings:extra_rustc_flag. Multiple uses are accumulated and appended after the extra_rustc_flags. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flag","id":"14","title":"extra_rustc_flag"},"140":{"body":"rust_bindgen(name, bindgen_flags, cc_lib, clang_flags, header, merge_cc_lib_objects_into_rlib, wrap_static_fns) Generates a rust source file from a cc_library and a header. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. List of strings optional [] cc_lib The cc_library that contains the .h file. This is used to find the transitive includes. Label required clang_flags Flags to pass directly to the clang executable. List of strings optional [] header The .h file to generate bindings for. Label required merge_cc_lib_objects_into_rlib When True, objects from cc_lib will be copied into the rlib archive produced by the rust_library that depends on this rust_bindgen rule (using BuildInfo provider) Boolean optional True wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains). Boolean optional False","breadcrumbs":"Extensions » bindgen » rust_bindgen","id":"140","title":"rust_bindgen"},"141":{"body":"rust_bindgen_toolchain(name, bindgen, clang, default_rustfmt, libclang, libstdcxx) The tools required for the rust_bindgen rule. This rule depends on the bindgen binary crate, and it in turn depends on both a clang binary and the clang library. To obtain these dependencies, rust_bindgen_dependencies imports bindgen and its dependencies. load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( name = \"bindgen_toolchain_impl\", bindgen = \"//my/rust:bindgen\", clang = \"//my/clang:clang\", libclang = \"//my/clang:libclang.so\", libstdcxx = \"//my/cpp:libstdc++\",\n) toolchain( name = \"bindgen_toolchain\", toolchain = \"bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_bindgen//:toolchain_type\",\n) This toolchain will then need to be registered in the current WORKSPACE. For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a bindgen executable. Label optional None clang The label of a clang executable. Label optional None default_rustfmt If set, rust_bindgen targets will always format generated sources with rustfmt. Boolean optional True libclang A cc_library that provides bindgen's runtime dependency on libclang. Label optional None libstdcxx A cc_library that satisfies libclang's libstdc++ dependency. This is used to make the execution of clang hermetic. If None, system libraries will be used instead. Label optional None","breadcrumbs":"Extensions » bindgen » rust_bindgen_toolchain","id":"141","title":"rust_bindgen_toolchain"},"142":{"body":"rust_bindgen_library(name, header, cc_lib, bindgen_flags, bindgen_features, clang_flags, wrap_static_fns, kwargs) Generates a rust source file for header, and builds a rust_library. Arguments are the same as rust_bindgen, and kwargs are passed directly to rust_library. PARAMETERS Name Description Default Value name A unique name for this target. none header The label of the .h file to generate bindings for. none cc_lib The label of the cc_library that contains the .h file. This is used to find the transitive includes. none bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. None bindgen_features The features attribute for the rust_bindgen target. None clang_flags Flags to pass directly to the clang executable. None wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains\", False kwargs Arguments to forward to the underlying rust_library rule. none","breadcrumbs":"Extensions » bindgen » rust_bindgen_library","id":"142","title":"rust_bindgen_library"},"143":{"body":"Bazel rules for mdBook .","breadcrumbs":"Extensions » mdbook » rules_rust_mdbook","id":"143","title":"rules_rust_mdbook"},"144":{"body":"mdbook mdbook_server mdbook_toolchain","breadcrumbs":"Extensions » mdbook » Rules","id":"144","title":"Rules"},"145":{"body":"","breadcrumbs":"Extensions » mdbook » Setup","id":"145","title":"Setup"},"146":{"body":"bazel_dep(name = \"rules_rust_mdbook\", version = \"{SEE_RELEASE_NOTES}\")","breadcrumbs":"Extensions » mdbook » bzlmod","id":"146","title":"bzlmod"},"147":{"body":"load(\"@rules_rust_mdbook//:repositories.bzl\", \"mdbook_register_toolchains\", \"rules_mdbook_dependencies\") rules_mdbook_dependencies() mdbook_register_toolchains() load(\"@rules_rust_mdbook//:repositories_transitive.bzl\", \"rules_mdbook_transitive_deps\") rules_mdbook_transitive_deps()","breadcrumbs":"Extensions » mdbook » WORKSPACE","id":"147","title":"WORKSPACE"},"148":{"body":"mdbook(name, srcs, book, plugins) Rules to create book from markdown files using mdBook. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required srcs All inputs to the book. List of labels optional [] book The book.toml file. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook","id":"148","title":"mdbook"},"149":{"body":"mdbook_server(name, book, hostname, port) Spawn an mdbook server for a given mdbook target. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required book The mdbook target to serve. Label required hostname The default hostname to use (Can be overridden on the command line). String optional \"localhost\" port The default port to use (Can be overridden on the command line). String optional \"3000\"","breadcrumbs":"Extensions » mdbook » mdbook_server","id":"149","title":"mdbook_server"},"15":{"body":"extra_rustc_flags(name) Add additional rustc_flags from the command line with --@rules_rust//rust/settings:extra_rustc_flags. This flag should only be used for flags that need to be applied across the entire build. For options that apply to individual crates, use the rustc_flags attribute on the individual crate's rule instead. NOTE: These flags not applied to the exec configuration (proc-macros, cargo_build_script, etc); use --@rules_rust//rust/settings:extra_exec_rustc_flags to apply flags to the exec configuration. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flags","id":"15","title":"extra_rustc_flags"},"150":{"body":"mdbook_toolchain(name, mdbook, plugins) A mdBook toolchain. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required mdbook A mdBook binary. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook_toolchain","id":"150","title":"mdbook_toolchain"},"151":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using Prost and Tonic","breadcrumbs":"Extensions » prost » rules_rust_prost","id":"151","title":"rules_rust_prost"},"152":{"body":"rust_prost_library rust_prost_toolchain","breadcrumbs":"Extensions » prost » Rules","id":"152","title":"Rules"},"153":{"body":"load(\"@rules_rust//proto/prost:repositories.bzl\", \"rust_prost_dependencies\") rust_prost_dependencies() load(\"@rules_rust//proto/prost:transitive_repositories.bzl\", \"rust_prost_transitive_repositories\") rust_prost_transitive_repositories() The prost and tonic rules do not specify a default toolchain in order to avoid mismatched dependency issues. To setup the prost and tonic toolchain, please see the section Customizing prost and tonic Dependencies . For additional information about Bazel toolchains, see here . Customizing prost and tonic Dependencies These rules depend on the prost and tonic dependencies. To setup the necessary toolchain for these rules, you must define a toolchain with the prost , prost-types , tonic , protoc-gen-prost , and protoc-gen-tonic crates as well as the protoc binary. To get access to these crates, you can use the crate_universe repository rules. For example: load(\"//crate_universe:defs.bzl\", \"crate\", \"crates_repository\") crates_repository( name = \"crates_io\", annotations = { \"protoc-gen-prost\": [crate.annotation( gen_binaries = [\"protoc-gen-prost\"], patch_args = [ \"-p1\", ], patches = [ # Note: You will need to use this patch until a version greater than `0.2.2` of # `protoc-gen-prost` is released. \"@rules_rust//proto/prost/private/3rdparty/patches:protoc-gen-prost.patch\", ], )], \"protoc-gen-tonic\": [crate.annotation( gen_binaries = [\"protoc-gen-tonic\"], )], }, cargo_lockfile = \"Cargo.Bazel.lock\", mode = \"remote\", packages = { \"prost\": crate.spec( version = \"0\", ), \"prost-types\": crate.spec( version = \"0\", ), \"protoc-gen-prost\": crate.spec( version = \"0\", ), \"protoc-gen-tonic\": crate.spec( version = \"0\", ), \"tonic\": crate.spec( version = \"0\", ), }, repository_name = \"rules_rust_prost\", tags = [\"manual\"],\n) You can then define a toolchain with the rust_prost_toolchain rule which uses the crates defined above. For example: load(\"@rules_rust//proto/prost:defs.bzl\", \"rust_prost_toolchain\")\nload(\"@rules_rust//rust:defs.bzl\", \"rust_library_group\") rust_library_group( name = \"prost_runtime\", deps = [ \"@crates_io//:prost\", ],\n) rust_library_group( name = \"tonic_runtime\", deps = [ \":prost_runtime\", \"@crates_io//:tonic\", ],\n) rust_prost_toolchain( name = \"prost_toolchain_impl\", prost_plugin = \"@crates_io//:protoc-gen-prost__protoc-gen-prost\", prost_runtime = \":prost_runtime\", prost_types = \"@crates_io//:prost-types\", proto_compiler = \"@com_google_protobuf//:protoc\", tonic_plugin = \"@crates_io//:protoc-gen-tonic__protoc-gen-tonic\", tonic_runtime = \":tonic_runtime\",\n) toolchain( name = \"prost_toolchain\", toolchain = \"prost_toolchain_impl\", toolchain_type = \"@rules_rust//proto/prost:toolchain_type\",\n) Lastly, you must register the toolchain in your WORKSPACE file. For example: register_toolchains(\"//toolchains:prost_toolchain\")","breadcrumbs":"Extensions » prost » Setup","id":"153","title":"Setup"},"154":{"body":"rust_prost_library(name, proto) A rule for generating a Rust library using Prost. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required proto A proto_library target for which to generate Rust gencode. Label required","breadcrumbs":"Extensions » prost » rust_prost_library","id":"154","title":"rust_prost_library"},"155":{"body":"rust_prost_toolchain(name, include_transitive_deps, prost_opts, prost_plugin, prost_plugin_flag, prost_runtime, prost_types, proto_compiler, tonic_opts, tonic_plugin, tonic_plugin_flag, tonic_runtime) Rust Prost toolchain rule. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required include_transitive_deps Whether to include transitive dependencies. If set to True, all transitive dependencies will directly accessible by the dependent crate. Boolean optional False prost_opts Additional options to add to Prost. List of strings optional [] prost_plugin Additional plugins to add to Prost. Label required prost_plugin_flag Prost plugin flag format. (e.g. --plugin=protoc-gen-prost=%s) String optional \"--plugin=protoc-gen-prost=%s\" prost_runtime The Prost runtime crates to use. Label required prost_types The Prost types crates to use. Label required proto_compiler The protoc compiler to use. Note that this attribute is deprecated - prefer to use --incompatible_enable_proto_toolchain_resolution. Label optional None tonic_opts Additional options to add to Tonic. List of strings optional [] tonic_plugin Additional plugins to add to Tonic. Label optional None tonic_plugin_flag Tonic plugin flag format. (e.g. --plugin=protoc-gen-tonic=%s)) String optional \"--plugin=protoc-gen-tonic=%s\" tonic_runtime The Tonic runtime crates to use. Label optional None","breadcrumbs":"Extensions » prost » rust_prost_toolchain","id":"155","title":"rust_prost_toolchain"},"156":{"body":"rust_prost_transform(name, deps, srcs, prost_opts, tonic_opts) A rule for transforming the outputs of ProstGenProto actions. This rule is used by adding it to the data attribute of proto_library targets. E.g. load(\"@rules_proto//proto:defs.bzl\", \"proto_library\")\nload(\"@rules_rust_prost//:defs.bzl\", \"rust_prost_library\", \"rust_prost_transform\") rust_prost_transform( name = \"a_transform\", srcs = [ \"a_src.rs\", ],\n) proto_library( name = \"a_proto\", srcs = [ \"a.proto\", ], data = [ \":transform\", ],\n) rust_prost_library( name = \"a_rs_proto\", proto = \":a_proto\",\n) The rust_prost_library will spawn an action on the a_proto target which consumes the a_transform rule to provide a means of granularly modifying a proto library for ProstGenProto actions with minimal impact to other consumers. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Additional dependencies to add to the compiled crate. List of labels optional [] srcs Additional source files to include in generated Prost source code. List of labels optional [] prost_opts Additional options to add to Prost. List of strings optional [] tonic_opts Additional options to add to Tonic. List of strings optional []","breadcrumbs":"Extensions » prost » rust_prost_transform","id":"156","title":"rust_prost_transform"},"157":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using rust-protobuf .","breadcrumbs":"Extensions » protobuf » rules_rust_protobuf","id":"157","title":"rules_rust_protobuf"},"158":{"body":"To use the Rust proto rules, add the following to your WORKSPACE file to add the external repositories for the Rust proto toolchain (in addition to the rust rules setup ): load(\"@rules_rust//proto/protobuf:repositories.bzl\", \"rust_proto_protobuf_dependencies\", \"rust_proto_protobuf_register_toolchains\") rust_proto_protobuf_dependencies() rust_proto_protobuf_register_toolchains() load(\"@rules_rust//proto/protobuf:transitive_repositories.bzl\", \"rust_proto_protobuf_transitive_repositories\") rust_proto_protobuf_transitive_repositories() This will load the required dependencies for the rust-protobuf rules. It will also register a default toolchain for the rust_proto_library and rust_grpc_library rules. To customize the rust_proto_library and rust_grpc_library toolchain, please see the section Customizing rust-protobuf Dependencies . For additional information about Bazel toolchains, see here . Customizing rust-protobuf Dependencies These rules depend on the protobuf and the grpc crates in addition to the protobuf compiler . To obtain these crates, rust_proto_repositories imports the given crates using BUILD files generated with crate_universe . If you want to either change the protobuf and gRPC rust compilers, or to simply use crate_universe in a more complex scenario (with more dependencies), you must redefine those dependencies. To do this, once you've imported the needed dependencies (see our @rules_rust//proto/protobuf/3rdparty/BUILD.bazel file to see the default dependencies), you need to create your own toolchain. To do so you can create a BUILD file with your toolchain definition, for example: load(\"@rules_rust//proto:toolchain.bzl\", \"rust_proto_toolchain\") rust_proto_toolchain( name = \"proto-toolchain-impl\", # Path to the protobuf compiler. protoc = \"@com_google_protobuf//:protoc\", # Protobuf compiler plugin to generate rust gRPC stubs. grpc_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust_grpc\", # Protobuf compiler plugin to generate rust protobuf stubs. proto_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust\",\n) toolchain( name = \"proto-toolchain\", toolchain = \":proto-toolchain-impl\", toolchain_type = \"@rules_rust//proto/protobuf:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:proto-toolchain\") Finally, you might want to set the rust_deps attribute in rust_proto_library and rust_grpc_library to change the compile-time dependencies: rust_proto_library( ... rust_deps = [\"//3rdparty/crates:protobuf\"], ...\n) rust_grpc_library( ... rust_deps = [ \"//3rdparty/crates:protobuf\", \"//3rdparty/crates:grpc\", \"//3rdparty/crates:tls_api\", \"//3rdparty/crates:tls_api_stub\", ], ...\n) Note : Ideally, we would inject those dependencies from the toolchain, but due to bazelbuild/bazel#6889 all dependencies added via the toolchain ends-up being in the wrong configuration.","breadcrumbs":"Extensions » protobuf » Setup","id":"158","title":"Setup"},"159":{"body":"rust_grpc_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys suitable for gRPC. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_grpc_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_grpc_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_service\", srcs = [\"my_service.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding gRPC stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_grpc_library","id":"159","title":"rust_grpc_library"},"16":{"body":"rust_binary(name, deps, srcs, data, aliases, alwayslink, binary_name, compile_data, crate_features, crate_name, crate_root, crate_type, edition, env, experimental_use_cc_common_link, linker_script, malloc, out_binary, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust binary crate. Example: Suppose you have the following directory structure for a Rust project with a library crate, hello_lib, and a binary crate, hello_world that uses the hello_lib library: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_world/ BUILD src/ main.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) hello_world/src/main.rs: extern crate hello_lib; fn main() { let hello = hello_lib::Greeter::new(\"Hello\"); hello.greet(\"world\");\n} hello_world/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_binary\") rust_binary( name = \"hello_world\", srcs = [\"src/main.rs\"], deps = [\"//hello_lib\"],\n) Build and run hello_world: $ bazel run //hello_world\nINFO: Found 1 target...\nTarget //examples/rust/hello_world:hello_world up-to-date:\nbazel-bin/examples/rust/hello_world/hello_world\nINFO: Elapsed time: 1.308s, Critical Path: 1.22s INFO: Running command line: bazel-bin/examples/rust/hello_world/hello_world\nHello world On Windows, a PDB file containing debugging information is available under the key pdb_file in OutputGroupInfo. Similarly on macOS, a dSYM folder is available under the key dsym_folder in OutputGroupInfo. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False binary_name Override the resulting binary file name. By default, the binary file will be named using the name attribute on this rule, however sometimes that is not deseriable. String optional \"\" compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None crate_type Crate type that will be passed to rustc to be used for building this crate.This option is a temporary workaround and should be used only when building for WebAssembly targets (//rust/platform:wasi and //rust/platform:wasm). String optional \"bin\" edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the target is executed by bazel run. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution.Execpath returns absolute path, and in order to be able to construct the absolute path we need to wrap the test binary in a launcher. Using a launcher comes with complications, such as more complicated debugger attachment. Dictionary: String -> String optional {} experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 linker_script Link script to forward into linker via rustc options. Label optional None malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" out_binary Force a target, regardless of it's crate_type, to always mark the file as executable. This attribute is only used to support wasm targets but is expected to be removed following a resolution to https://github.com/bazelbuild/rules_rust/issues/771. Boolean optional False platform Optional platform to transition the binary to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional -1 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_binary","id":"16","title":"rust_binary"},"160":{"body":"rust_proto_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_proto_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_proto_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_proto_binary\", srcs = [\"my_proto_binary.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_proto_library","id":"160","title":"rust_proto_library"},"161":{"body":"Bazel rules for generating wasm modules for Javascript using wasm-bindgen .","breadcrumbs":"Extensions » wasm_bindgen » rules_rust_wasm_bindgen","id":"161","title":"rules_rust_wasm_bindgen"},"162":{"body":"rust_wasm_bindgen rust_wasm_bindgen_toolchain","breadcrumbs":"Extensions » wasm_bindgen » Rules","id":"162","title":"Rules"},"163":{"body":"To begin using the wasm-bindgen rules, users can load the necessary dependencies in their workspace by adding the following to their WORKSPACE.bazel file. load(\"@rules_rust_wasm_bindgen//:repositories.bzl\", \"rust_wasm_bindgen_dependencies\", \"rust_wasm_bindgen_register_toolchains\") rust_wasm_bindgen_dependencies() rust_wasm_bindgen_register_toolchains() This should enable users to start using the rust_wasm_bindgen rule. However, it's common to want to control the version of wasm-bindgen in the workspace instead of relying on the one provided by rules_rust. In this case, users should avoid calling rust_wasm_bindgen_register_toolchains and instead use the rust_wasm_bindgen_toolchain rule to define their own toolchains to register in the workspace.","breadcrumbs":"Extensions » wasm_bindgen » Setup","id":"163","title":"Setup"},"164":{"body":"While it's recommended for users to mantain their own , in the @rules_rust_wasm_bindgen package there exists interface sub-packages for various Javascript Bazel rules. E.g. aspect_rules_js. The rules defined there are a more convenient way to use rust_wasm_bindgen with the associated javascript rules due to the inclusion of additional providers. Each directory contains a defs.bzl file that defines the different variants of rust_wasm_bindgen. (e.g. js_rust_wasm_bindgen for the rules_js submodule).","breadcrumbs":"Extensions » wasm_bindgen » Interfacing with Javascript rules","id":"164","title":"Interfacing with Javascript rules"},"165":{"body":"rust_wasm_bindgen(name, bindgen_flags, out_name, target, target_arch, wasm_file) Generates javascript and typescript bindings for a webassembly module using wasm-bindgen . An example of this rule in use can be seen at @rules_rust//examples/wasm ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the wasm-bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details. List of strings optional [] out_name Set a custom output filename (Without extension. Defaults to target name). String optional \"\" target The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details. String optional \"bundler\" target_arch The target architecture to use for the wasm-bindgen command line option. String optional \"wasm32\" wasm_file The .wasm file or crate to generate bindings for. Label required","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen","id":"165","title":"rust_wasm_bindgen"},"166":{"body":"rust_wasm_bindgen_toolchain(name, bindgen) The tools required for the rust_wasm_bindgen rule. In cases where users want to control or change the version of wasm-bindgen used by rust_wasm_bindgen , a unique toolchain can be created as in the example below: load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( bindgen = \"//3rdparty/crates:wasm_bindgen_cli__bin\",\n) toolchain( name = \"wasm_bindgen_toolchain\", toolchain = \"wasm_bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_wasm_bindgen//:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:wasm_bindgen_toolchain\") For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a wasm-bindgen-cli executable. Label optional None","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen_toolchain","id":"166","title":"rust_wasm_bindgen_toolchain"},"167":{"body":"RustWasmBindgenInfo(js, root, snippets, ts, wasm) Info about wasm-bindgen outputs. FIELDS Name Description js Depset[File]: The Javascript files produced by wasm-bindgen. root str: The path to the root of the wasm-bindgen --out-dir directory. snippets File: The snippets directory produced by wasm-bindgen. ts Depset[File]: The Typescript files produced by wasm-bindgen. wasm File: The .wasm file generated by wasm-bindgen.","breadcrumbs":"Extensions » wasm_bindgen » RustWasmBindgenInfo","id":"167","title":"RustWasmBindgenInfo"},"17":{"body":"rust_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, disable_pipelining, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust library crate. Example: Suppose you have the following directory structure for a simple Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ greeter.rs lib.rs hello_lib/src/greeter.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/src/lib.rs: pub mod greeter; hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [ \"src/greeter.rs\", \"src/lib.rs\", ],\n) Build the library: $ bazel build //hello_lib\nINFO: Found 1 target...\nTarget //examples/rust/hello_lib:hello_lib up-to-date:\nbazel-bin/examples/rust/hello_lib/libhello_lib.rlib\nINFO: Elapsed time: 1.245s, Critical Path: 1.01s ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None disable_pipelining Disables pipelining for this rule if it is globally enabled. This will cause this rule to not produce a .rmeta file and all the dependent crates will instead use the .rlib file. Boolean optional False edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_library","id":"17","title":"rust_library"},"18":{"body":"rust_library_group(name, deps) Functions as an alias for a set of dependencies. Specifically, the following are equivalent: rust_library_group( name = \"crate_group\", deps = [ \":crate1\", \":crate2\", ],\n) rust_library( name = \"foobar\", deps = [\":crate_group\"], ...\n) and rust_library( name = \"foobar\", deps = [ \":crate1\", \":crate2\", ], ...\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Other dependencies to forward through this crate group. List of labels optional []","breadcrumbs":"Rules » rust » rust_library_group","id":"18","title":"rust_library_group"},"19":{"body":"rust_proc_macro(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust proc-macro crate. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_proc_macro","id":"19","title":"rust_proc_macro"},"2":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust\", version = \"0.48.0\") Don't forget to substitute in your desired release's version number.","breadcrumbs":"Introduction » Bzlmod","id":"2","title":"Bzlmod"},"20":{"body":"rust_shared_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust shared library. This shared library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce a shared library that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the shared library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_shared_library","id":"20","title":"rust_shared_library"},"21":{"body":"rust_static_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust static library. This static library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce an archive that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" platform Optional platform to transition the static library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_static_library","id":"21","title":"rust_static_library"},"22":{"body":"rust_test(name, deps, srcs, data, aliases, alwayslink, compile_data, crate, crate_features, crate_name, crate_root, edition, env, env_inherit, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, use_libtest_harness, version) Builds a Rust test crate. Examples: Suppose you have the following directory structure for a Rust library crate with unit test code in the library sources: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) -> String { format!(\"{} {}\", &self.greeting, thing) }\n} #[cfg(test)]\nmod test { use super::Greeter; #[test] fn test_greeting() { let hello = Greeter::new(\"Hi\"); assert_eq!(\"Hi Rust\", hello.greet(\"Rust\")); }\n} To build and run the tests, simply add a rust_test rule with no srcs and only depends on the hello_lib rust_library target via the crate attribute: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"hello_lib_test\", crate = \":hello_lib\", # You may add other deps that are specific to the test configuration deps = [\"//some/dev/dep\"],\n) Run the test with bazel test //hello_lib:hello_lib_test.","breadcrumbs":"Rules » rust » rust_test","id":"22","title":"rust_test"},"23":{"body":"Integration tests that live in the tests directory , they are essentially built as separate crates. Suppose you have the following directory structure where greeting.rs is an integration test for the hello_lib library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs tests/ greeting.rs hello_lib/tests/greeting.rs: extern crate hello_lib; use hello_lib; #[test]\nfn test_greeting() { let hello = greeter::Greeter::new(\"Hello\"); assert_eq!(\"Hello world\", hello.greeting(\"world\"));\n} To build the greeting.rs integration test, simply add a rust_test target with greeting.rs in srcs and a dependency on the hello_lib target: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"greeting_test\", srcs = [\"tests/greeting.rs\"], deps = [\":hello_lib\"],\n) Run the test with bazel test //hello_lib:greeting_test. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate Target inline tests declared in the given crateThese tests are typically those that would be held out under #[cfg(test)] declarations. Label optional None crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the test is executed by bazel test. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution. Dictionary: String -> String optional {} env_inherit Specifies additional environment variables to inherit from the external environment when the test is executed by bazel test. List of strings optional [] experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the test to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 use_libtest_harness Whether to use libtest. For targets using this flag, individual tests can be run by using the --test_arg flag. E.g. bazel test //src:rust_test --test_arg=foo::test::test_fn. Boolean optional True version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » Example: test directory","id":"23","title":"Example: test directory"},"24":{"body":"rust_test_suite(name, srcs, shared_srcs, kwargs) A rule for creating a test suite for a set of rust_test targets. This rule can be used for setting up typical rust integration tests . Given the following directory structure: [crate]/ BUILD.bazel src/ lib.rs main.rs tests/ integrated_test_a.rs integrated_test_b.rs integrated_test_c.rs patterns/ fibonacci_test.rs helpers/ mod.rs The rule can be used to generate rust_test targets for each source file under tests and a test_suite which encapsulates all tests. load(\"//rust:defs.bzl\", \"rust_binary\", \"rust_library\", \"rust_test_suite\") rust_library( name = \"math_lib\", srcs = [\"src/lib.rs\"],\n) rust_binary( name = \"math_bin\", srcs = [\"src/main.rs\"],\n) rust_test_suite( name = \"integrated_tests_suite\", srcs = glob([\"tests/**\"]), shared_srcs=glob([\"tests/helpers/**\"]), deps = [\":math_lib\"],\n) PARAMETERS Name Description Default Value name The name of the test_suite. none srcs All test sources, typically glob([\"tests/**/*.rs\"]). none shared_srcs Optional argument for sources shared among tests, typically helper functions. [] kwargs Additional keyword arguments for the underyling rust_test targets. The tags argument is also passed to the generated test_suite target. none","breadcrumbs":"Rules » rust » rust_test_suite","id":"24","title":"rust_test_suite"},"25":{"body":"rust_doc rust_doc_test","breadcrumbs":"Rules » rustdoc » Rust Doc","id":"25","title":"Rust Doc"},"26":{"body":"rust_doc(name, crate, html_after_content, html_before_content, html_in_header, markdown_css, rustc_flags, rustdoc_flags) Generates code documentation. Example: Suppose you have the following directory structure for a Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs To build rustdoc documentation for the hello_lib crate, define a rust_doc rule that depends on the the hello_lib rust_library target: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_doc\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_doc( name = \"hello_lib_doc\", crate = \":hello_lib\",\n) Running bazel build //hello_lib:hello_lib_doc will build a zip file containing the documentation for the hello_lib library crate generated by rustdoc. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required crate The label of the target to generate code documentation for.rust_doc can generate HTML code documentation for the source files of rust_library or rust_binary targets. Label required html_after_content File to add in , after content. Label optional None html_before_content File to add in , before content. Label optional None html_in_header File to add to . Label optional None markdown_css CSS files to include via :' that takes a single label parameter 'actual'. See '@crate_index//:alias_rules.bzl' for an example. \"alias\" default_package_name The default package name to use in the rendered macros. This affects the auto package detection of things like all_crate_deps. None generate_target_compatible_with Whether to generate target_compatible_with annotations on the generated BUILD files. This catches a target_triplebeing targeted that isn't declared in supported_platform_triples. True platforms_template The base template to use for platform names. See platforms documentation . The available format keys are [{triple}]. \"@rules_rust//rust/platform:{triple}\" regen_command An optional command to demonstrate how generated files should be regenerated. None vendor_mode An optional configuration for rendirng content to be rendered into repositories. None generate_rules_license_metadata Whether to generate rules license metedata False RETURNS string: A json encoded struct to match the Rust config::RenderConfig struct","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » render_config","id":"128","title":"render_config"},"129":{"body":"splicing_config(resolver_version) Various settings used to configure Cargo manifest splicing behavior. PARAMETERS Name Description Default Value resolver_version The resolver version to use in generated Cargo manifests. This flag is only used when splicing a manifest from direct package definitions. See crates_repository::packages. \"2\" RETURNS str: A json encoded string of the parameters provided","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » splicing_config","id":"129","title":"splicing_config"},"13":{"body":"error_format(name) Change the --error-format flag from the command line with --@rules_rust//rust/settings:error_format. See rustc documentation for valid values. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » error_format","id":"13","title":"error_format"},"130":{"body":"crates_repository(name, annotations, cargo_config, cargo_lockfile, compressed_windows_toolchain_names, generate_binaries, generate_build_scripts, generate_target_compatible_with, generator, generator_sha256s, generator_urls, isolated, lockfile, manifests, packages, quiet, render_config, repin_instructions, repo_mapping, rust_toolchain_cargo_template, rust_toolchain_rustc_template, rust_version, splicing_config, supported_platform_triples) A rule for defining and downloading Rust dependencies (crates). This rule handles all the same workflows crate_universe rules do. Environment Variables: variable usage CARGO_BAZEL_GENERATOR_SHA256 The sha256 checksum of the file located at CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_URL The URL of a cargo-bazel binary. This variable takes precedence over attributes and can use file:// for local paths CARGO_BAZEL_ISOLATED An authorative flag as to whether or not the CARGO_HOME environment variable should be isolated from the host configuration CARGO_BAZEL_REPIN An indicator that the dependencies represented by the rule should be regenerated. REPIN may also be used. See Repinning / Updating Dependencies for more details. CARGO_BAZEL_REPIN_ONLY A comma-delimited allowlist for rules to execute repinning. Can be useful if multiple instances of the repository rule are used in a Bazel workspace, but repinning should be limited to one of them. Example: Given the following workspace structure: [workspace]/ WORKSPACE.bazel BUILD.bazel Cargo.toml Cargo.Bazel.lock src/ main.rs The following is something that'd be found in the WORKSPACE file: load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_repository\", \"crate\") crates_repository( name = \"crate_index\", annotations = { \"rand\": [crate.annotation( default_features = False, features = [\"small_rng\"], )], }, cargo_lockfile = \"//:Cargo.Bazel.lock\", lockfile = \"//:cargo-bazel-lock.json\", manifests = [\"//:Cargo.toml\"], # Should match the version represented by the currently registered `rust_toolchain`. rust_version = \"1.60.0\",\n) The above will create an external repository which contains aliases and macros for accessing Rust targets found in the dependency graph defined by the given manifests. NOTE : The cargo_lockfile and lockfile must be manually created. The rule unfortunately does not yet create it on its own. When initially setting up this rule, an empty file should be created and then populated by repinning dependencies.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crates_repository","id":"130","title":"crates_repository"},"131":{"body":"Dependency syncing and updating is done in the repository rule which means it's done during the analysis phase of builds. As mentioned in the environments variable table above, the CARGO_BAZEL_REPIN (or REPIN) environment variables can be used to force the rule to update dependencies and potentially render a new lockfile. Given an instance of this repository rule named crate_index, the easiest way to repin dependencies is to run: CARGO_BAZEL_REPIN=1 bazel sync --only=crate_index This will result in all dependencies being updated for a project. The CARGO_BAZEL_REPIN environment variable can also be used to customize how dependencies are updated. The following table shows translations from environment variable values to the equivilant cargo update command that is called behind the scenes to update dependencies. Value Cargo command Any of [true, 1, yes, on, workspace] cargo update --workspace Any of [full, eager, all] cargo update package_name cargo upgrade --package package_name package_name@1.2.3 cargo upgrade --package package_name@1.2.3 package_name@1.2.3=4.5.6 cargo upgrade --package package_name@1.2.3 --precise=4.5.6 If the crates_repository is used multiple times in the same Bazel workspace (e.g. for multiple independent Rust workspaces), it may additionally be useful to use the CARGO_BAZEL_REPIN_ONLY environment variable, which limits execution of the repinning to one or multiple instances of the crates_repository rule via a comma-delimited allowlist: CARGO_BAZEL_REPIN=1 CARGO_BAZEL_REPIN_ONLY=crate_index bazel sync --only=crate_index ATTRIBUTES Name Description Type Mandatory Default name A unique name for this repository. Name required annotations Extra settings to apply to crates. See crate.annotation . Dictionary: String -> List of strings optional {} cargo_config A Cargo configuration file Label optional None cargo_lockfile The path used to store the crates_repository specific Cargo.lock file. In the case that your crates_repository corresponds directly with an existing Cargo.toml file which has a paired Cargo.lock file, that Cargo.lock file should be used here, which will keep the versions used by cargo and bazel in sync. Label required compressed_windows_toolchain_names Wether or not the toolchain names of windows toolchains are expected to be in a compressed format. Boolean optional True generate_binaries Whether to generate rust_binary targets for all the binary crates in every package. By default only the rust_library targets are generated. Boolean optional False generate_build_scripts Whether or not to generate cargo build scripts by default. Boolean optional True generate_target_compatible_with DEPRECATED: Moved to render_config. Boolean optional True generator The absolute label of a generator. Eg. @cargo_bazel_bootstrap//:cargo-bazel. This is typically used when bootstrapping String optional \"\" generator_sha256s Dictionary of host_triple -> sha256 for a cargo-bazel binary. Dictionary: String -> String optional {} generator_urls URL template from which to download the cargo-bazel binary. {host_triple} and will be filled in according to the host platform. Dictionary: String -> String optional {} isolated If true, CARGO_HOME will be overwritten to a directory within the generated repository in order to prevent other uses of Cargo from impacting having any effect on the generated targets produced by this rule. For users who either have multiple crate_repository definitions in a WORKSPACE or rapidly re-pin dependencies, setting this to false may improve build times. This variable is also controled by CARGO_BAZEL_ISOLATED environment variable. Boolean optional True lockfile The path to a file to use for reproducible renderings. If set, this file must exist within the workspace (but can be empty) before this rule will work. Label optional None manifests A list of Cargo manifests (Cargo.toml files). List of labels optional [] packages A set of crates (packages) specifications to depend on. See crate.spec . Dictionary: String -> String optional {} quiet If stdout and stderr should not be printed to the terminal. Boolean optional True render_config The configuration flags to use for rendering. Use //crate_universe:defs.bzl\\%render_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" repin_instructions Instructions to re-pin the repository if required. Many people have wrapper scripts for keeping dependencies up to date, and would like to point users to that instead of the default. String optional \"\" repo_mapping In WORKSPACE context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.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).This attribute is not supported in MODULE.bazel context (when invoking a repository rule inside a module extension's implementation function). Dictionary: String -> String optional rust_toolchain_cargo_template The template to use for finding the host cargo binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'rustc.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_toolchain_rustc_template The template to use for finding the host rustc binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'cargo.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_version The version of Rust the currently registered toolchain is using. Eg. 1.56.0, or nightly/2021-09-08 String optional \"1.83.0\" splicing_config The configuration flags to use for splicing Cargo maniests. Use //crate_universe:defs.bzl\\%rsplicing_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" supported_platform_triples A set of all platform triples to consider when generating dependencies. List of strings optional [\"aarch64-apple-darwin\", \"aarch64-apple-ios\", \"aarch64-apple-ios-sim\", \"aarch64-linux-android\", \"aarch64-pc-windows-msvc\", \"aarch64-unknown-fuchsia\", \"aarch64-unknown-linux-gnu\", \"aarch64-unknown-nixos-gnu\", \"aarch64-unknown-nto-qnx710\", \"arm-unknown-linux-gnueabi\", \"armv7-linux-androideabi\", \"armv7-unknown-linux-gnueabi\", \"i686-apple-darwin\", \"i686-linux-android\", \"i686-pc-windows-msvc\", \"i686-unknown-freebsd\", \"i686-unknown-linux-gnu\", \"powerpc-unknown-linux-gnu\", \"riscv32imc-unknown-none-elf\", \"riscv64gc-unknown-none-elf\", \"s390x-unknown-linux-gnu\", \"thumbv7em-none-eabi\", \"thumbv8m.main-none-eabi\", \"wasm32-unknown-unknown\", \"wasm32-wasip1\", \"x86_64-apple-darwin\", \"x86_64-apple-ios\", \"x86_64-linux-android\", \"x86_64-pc-windows-msvc\", \"x86_64-unknown-freebsd\", \"x86_64-unknown-fuchsia\", \"x86_64-unknown-linux-gnu\", \"x86_64-unknown-nixos-gnu\", \"x86_64-unknown-none\"] ENVIRONMENT VARIABLES This repository rule depends on the following environment variables: CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_SHA256 CARGO_BAZEL_REPIN REPIN CARGO_BAZEL_REPIN_ONLY CARGO_BAZEL_ISOLATED CARGO_BAZEL_DEBUG","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Repinning / Updating Dependencies","id":"131","title":"Repinning / Updating Dependencies"},"132":{"body":"rules_rust manages versions of things like rustc. If you want to manually run upstream tooling configured at the versions, plugins and such that rules_rust has configured, rules_rust exposes these as targets in @rules_rust//tools/upstream_wrapper: % bazel query @rules_rust//tools/upstream_wrapper\n@rules_rust//tools/upstream_wrapper:cargo\n@rules_rust//tools/upstream_wrapper:cargo_clippy\n@rules_rust//tools/upstream_wrapper:rustc\n@rules_rust//tools/upstream_wrapper:rustfmt You can run them via bazel run, e.g. bazel run @rules_rust//tools/upstream_wrapper:cargo -- check.","breadcrumbs":"Upstream Tooling » Upstream Tooling","id":"132","title":"Upstream Tooling"},"133":{"body":"Bazel rules for interfacing with other rules and integrations with popular 3rd party tools.","breadcrumbs":"Extensions » Extensions","id":"133","title":"Extensions"},"134":{"body":"The extension rules are released with each release of rules_rust (core) which can be found on the GitHub Releases page . We recommend using the latest release from that page.","breadcrumbs":"Extensions » Setup","id":"134","title":"Setup"},"135":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust extensions in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust_{EXTENSION}\", version = \"{VERSION}\") Don't forget to substitute in your desired release's version number and {EXTENSION} with the name of the desired extension. E.g.: bazel_dep(name = \"rules_rust_bindgen\", version = \"0.55.0\")","breadcrumbs":"Extensions » Bzlmod","id":"135","title":"Bzlmod"},"136":{"body":"To use rules_rust extensions in a project using a WORKSPACE file, add the following to your WORKSPACE file to add the external repositories for the Rust toolchain: load(\"@bazel_tools//tools/build_defs/repo:http.bzl\", \"http_archive\") # To find additional information on this release or newer ones visit:\n# https://github.com/bazelbuild/rules_rust/releases\nhttp_archive( name = \"rules_rust_{EXTENSION}\", # See releases page\n) # Refer to the documentation of the desired rules for how to load other necessary dependencies. Don't forget to substitute in your desired release's version number, integrity hash, and {EXTENSION} with the name of the desired extension.","breadcrumbs":"Extensions » WORKSPACE","id":"136","title":"WORKSPACE"},"137":{"body":"These rules are for using Bindgen to generate Rust bindings to C (and some C++) libraries.","breadcrumbs":"Extensions » bindgen » rules_rust_bindgen","id":"137","title":"rules_rust_bindgen"},"138":{"body":"rust_bindgen rust_bindgen_library rust_bindgen_toolchain","breadcrumbs":"Extensions » bindgen » Rules","id":"138","title":"Rules"},"139":{"body":"To use the Rust bindgen rules, add the following to your WORKSPACE file to add the external repositories for the Rust bindgen toolchain (in addition to the rust rules setup ): load(\"@rules_rust_bindgen//:repositories.bzl\", \"rust_bindgen_dependencies\", \"rust_bindgen_register_toolchains\") rust_bindgen_dependencies() rust_bindgen_register_toolchains() load(\"@rules_rust_bindgen//:transitive_repositories.bzl\", \"rust_bindgen_transitive_dependencies\") rust_bindgen_transitive_dependencies() Bindgen aims to be as hermetic as possible so will end up building libclang from llvm-project from source. If this is found to be undesirable then no Bindgen related calls should be added to your WORKSPACE and instead users should define their own repositories using something akin to crate_universe and define their own toolchains following the instructions for rust_bindgen_toolchain .","breadcrumbs":"Extensions » bindgen » Setup","id":"139","title":"Setup"},"14":{"body":"extra_rustc_flag(name) Add additional rustc_flag from the command line with --@rules_rust//rust/settings:extra_rustc_flag. Multiple uses are accumulated and appended after the extra_rustc_flags. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flag","id":"14","title":"extra_rustc_flag"},"140":{"body":"rust_bindgen(name, bindgen_flags, cc_lib, clang_flags, header, merge_cc_lib_objects_into_rlib, wrap_static_fns) Generates a rust source file from a cc_library and a header. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. List of strings optional [] cc_lib The cc_library that contains the .h file. This is used to find the transitive includes. Label required clang_flags Flags to pass directly to the clang executable. List of strings optional [] header The .h file to generate bindings for. Label required merge_cc_lib_objects_into_rlib When True, objects from cc_lib will be copied into the rlib archive produced by the rust_library that depends on this rust_bindgen rule (using BuildInfo provider) Boolean optional True wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains). Boolean optional False","breadcrumbs":"Extensions » bindgen » rust_bindgen","id":"140","title":"rust_bindgen"},"141":{"body":"rust_bindgen_toolchain(name, bindgen, clang, default_rustfmt, libclang, libstdcxx) The tools required for the rust_bindgen rule. This rule depends on the bindgen binary crate, and it in turn depends on both a clang binary and the clang library. To obtain these dependencies, rust_bindgen_dependencies imports bindgen and its dependencies. load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( name = \"bindgen_toolchain_impl\", bindgen = \"//my/rust:bindgen\", clang = \"//my/clang:clang\", libclang = \"//my/clang:libclang.so\", libstdcxx = \"//my/cpp:libstdc++\",\n) toolchain( name = \"bindgen_toolchain\", toolchain = \"bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_bindgen//:toolchain_type\",\n) This toolchain will then need to be registered in the current WORKSPACE. For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a bindgen executable. Label optional None clang The label of a clang executable. Label optional None default_rustfmt If set, rust_bindgen targets will always format generated sources with rustfmt. Boolean optional True libclang A cc_library that provides bindgen's runtime dependency on libclang. Label optional None libstdcxx A cc_library that satisfies libclang's libstdc++ dependency. This is used to make the execution of clang hermetic. If None, system libraries will be used instead. Label optional None","breadcrumbs":"Extensions » bindgen » rust_bindgen_toolchain","id":"141","title":"rust_bindgen_toolchain"},"142":{"body":"rust_bindgen_library(name, header, cc_lib, bindgen_flags, bindgen_features, clang_flags, wrap_static_fns, kwargs) Generates a rust source file for header, and builds a rust_library. Arguments are the same as rust_bindgen, and kwargs are passed directly to rust_library. PARAMETERS Name Description Default Value name A unique name for this target. none header The label of the .h file to generate bindings for. none cc_lib The label of the cc_library that contains the .h file. This is used to find the transitive includes. none bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. None bindgen_features The features attribute for the rust_bindgen target. None clang_flags Flags to pass directly to the clang executable. None wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains\", False kwargs Arguments to forward to the underlying rust_library rule. none","breadcrumbs":"Extensions » bindgen » rust_bindgen_library","id":"142","title":"rust_bindgen_library"},"143":{"body":"Bazel rules for mdBook .","breadcrumbs":"Extensions » mdbook » rules_rust_mdbook","id":"143","title":"rules_rust_mdbook"},"144":{"body":"mdbook mdbook_server mdbook_toolchain","breadcrumbs":"Extensions » mdbook » Rules","id":"144","title":"Rules"},"145":{"body":"","breadcrumbs":"Extensions » mdbook » Setup","id":"145","title":"Setup"},"146":{"body":"bazel_dep(name = \"rules_rust_mdbook\", version = \"{SEE_RELEASE_NOTES}\")","breadcrumbs":"Extensions » mdbook » bzlmod","id":"146","title":"bzlmod"},"147":{"body":"load(\"@rules_rust_mdbook//:repositories.bzl\", \"mdbook_register_toolchains\", \"rules_mdbook_dependencies\") rules_mdbook_dependencies() mdbook_register_toolchains() load(\"@rules_rust_mdbook//:repositories_transitive.bzl\", \"rules_mdbook_transitive_deps\") rules_mdbook_transitive_deps()","breadcrumbs":"Extensions » mdbook » WORKSPACE","id":"147","title":"WORKSPACE"},"148":{"body":"mdbook(name, srcs, book, plugins) Rules to create book from markdown files using mdBook. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required srcs All inputs to the book. List of labels optional [] book The book.toml file. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook","id":"148","title":"mdbook"},"149":{"body":"mdbook_server(name, book, hostname, port) Spawn an mdbook server for a given mdbook target. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required book The mdbook target to serve. Label required hostname The default hostname to use (Can be overridden on the command line). String optional \"localhost\" port The default port to use (Can be overridden on the command line). String optional \"3000\"","breadcrumbs":"Extensions » mdbook » mdbook_server","id":"149","title":"mdbook_server"},"15":{"body":"extra_rustc_flags(name) Add additional rustc_flags from the command line with --@rules_rust//rust/settings:extra_rustc_flags. This flag should only be used for flags that need to be applied across the entire build. For options that apply to individual crates, use the rustc_flags attribute on the individual crate's rule instead. NOTE: These flags not applied to the exec configuration (proc-macros, cargo_build_script, etc); use --@rules_rust//rust/settings:extra_exec_rustc_flags to apply flags to the exec configuration. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flags","id":"15","title":"extra_rustc_flags"},"150":{"body":"mdbook_toolchain(name, mdbook, plugins) A mdBook toolchain. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required mdbook A mdBook binary. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook_toolchain","id":"150","title":"mdbook_toolchain"},"151":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using Prost and Tonic","breadcrumbs":"Extensions » prost » rules_rust_prost","id":"151","title":"rules_rust_prost"},"152":{"body":"rust_prost_library rust_prost_toolchain","breadcrumbs":"Extensions » prost » Rules","id":"152","title":"Rules"},"153":{"body":"load(\"@rules_rust//proto/prost:repositories.bzl\", \"rust_prost_dependencies\") rust_prost_dependencies() load(\"@rules_rust//proto/prost:transitive_repositories.bzl\", \"rust_prost_transitive_repositories\") rust_prost_transitive_repositories() The prost and tonic rules do not specify a default toolchain in order to avoid mismatched dependency issues. To setup the prost and tonic toolchain, please see the section Customizing prost and tonic Dependencies . For additional information about Bazel toolchains, see here . Customizing prost and tonic Dependencies These rules depend on the prost and tonic dependencies. To setup the necessary toolchain for these rules, you must define a toolchain with the prost , prost-types , tonic , protoc-gen-prost , and protoc-gen-tonic crates as well as the protoc binary. To get access to these crates, you can use the crate_universe repository rules. For example: load(\"//crate_universe:defs.bzl\", \"crate\", \"crates_repository\") crates_repository( name = \"crates_io\", annotations = { \"protoc-gen-prost\": [crate.annotation( gen_binaries = [\"protoc-gen-prost\"], patch_args = [ \"-p1\", ], patches = [ # Note: You will need to use this patch until a version greater than `0.2.2` of # `protoc-gen-prost` is released. \"@rules_rust//proto/prost/private/3rdparty/patches:protoc-gen-prost.patch\", ], )], \"protoc-gen-tonic\": [crate.annotation( gen_binaries = [\"protoc-gen-tonic\"], )], }, cargo_lockfile = \"Cargo.Bazel.lock\", mode = \"remote\", packages = { \"prost\": crate.spec( version = \"0\", ), \"prost-types\": crate.spec( version = \"0\", ), \"protoc-gen-prost\": crate.spec( version = \"0\", ), \"protoc-gen-tonic\": crate.spec( version = \"0\", ), \"tonic\": crate.spec( version = \"0\", ), }, repository_name = \"rules_rust_prost\", tags = [\"manual\"],\n) You can then define a toolchain with the rust_prost_toolchain rule which uses the crates defined above. For example: load(\"@rules_rust//proto/prost:defs.bzl\", \"rust_prost_toolchain\")\nload(\"@rules_rust//rust:defs.bzl\", \"rust_library_group\") rust_library_group( name = \"prost_runtime\", deps = [ \"@crates_io//:prost\", ],\n) rust_library_group( name = \"tonic_runtime\", deps = [ \":prost_runtime\", \"@crates_io//:tonic\", ],\n) rust_prost_toolchain( name = \"prost_toolchain_impl\", prost_plugin = \"@crates_io//:protoc-gen-prost__protoc-gen-prost\", prost_runtime = \":prost_runtime\", prost_types = \"@crates_io//:prost-types\", proto_compiler = \"@com_google_protobuf//:protoc\", tonic_plugin = \"@crates_io//:protoc-gen-tonic__protoc-gen-tonic\", tonic_runtime = \":tonic_runtime\",\n) toolchain( name = \"prost_toolchain\", toolchain = \"prost_toolchain_impl\", toolchain_type = \"@rules_rust//proto/prost:toolchain_type\",\n) Lastly, you must register the toolchain in your WORKSPACE file. For example: register_toolchains(\"//toolchains:prost_toolchain\")","breadcrumbs":"Extensions » prost » Setup","id":"153","title":"Setup"},"154":{"body":"rust_prost_library(name, proto) A rule for generating a Rust library using Prost. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required proto A proto_library target for which to generate Rust gencode. Label required","breadcrumbs":"Extensions » prost » rust_prost_library","id":"154","title":"rust_prost_library"},"155":{"body":"rust_prost_toolchain(name, include_transitive_deps, prost_opts, prost_plugin, prost_plugin_flag, prost_runtime, prost_types, proto_compiler, tonic_opts, tonic_plugin, tonic_plugin_flag, tonic_runtime) Rust Prost toolchain rule. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required include_transitive_deps Whether to include transitive dependencies. If set to True, all transitive dependencies will directly accessible by the dependent crate. Boolean optional False prost_opts Additional options to add to Prost. List of strings optional [] prost_plugin Additional plugins to add to Prost. Label required prost_plugin_flag Prost plugin flag format. (e.g. --plugin=protoc-gen-prost=%s) String optional \"--plugin=protoc-gen-prost=%s\" prost_runtime The Prost runtime crates to use. Label required prost_types The Prost types crates to use. Label required proto_compiler The protoc compiler to use. Note that this attribute is deprecated - prefer to use --incompatible_enable_proto_toolchain_resolution. Label optional None tonic_opts Additional options to add to Tonic. List of strings optional [] tonic_plugin Additional plugins to add to Tonic. Label optional None tonic_plugin_flag Tonic plugin flag format. (e.g. --plugin=protoc-gen-tonic=%s)) String optional \"--plugin=protoc-gen-tonic=%s\" tonic_runtime The Tonic runtime crates to use. Label optional None","breadcrumbs":"Extensions » prost » rust_prost_toolchain","id":"155","title":"rust_prost_toolchain"},"156":{"body":"rust_prost_transform(name, deps, srcs, prost_opts, tonic_opts) A rule for transforming the outputs of ProstGenProto actions. This rule is used by adding it to the data attribute of proto_library targets. E.g. load(\"@rules_proto//proto:defs.bzl\", \"proto_library\")\nload(\"@rules_rust_prost//:defs.bzl\", \"rust_prost_library\", \"rust_prost_transform\") rust_prost_transform( name = \"a_transform\", srcs = [ \"a_src.rs\", ],\n) proto_library( name = \"a_proto\", srcs = [ \"a.proto\", ], data = [ \":transform\", ],\n) rust_prost_library( name = \"a_rs_proto\", proto = \":a_proto\",\n) The rust_prost_library will spawn an action on the a_proto target which consumes the a_transform rule to provide a means of granularly modifying a proto library for ProstGenProto actions with minimal impact to other consumers. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Additional dependencies to add to the compiled crate. List of labels optional [] srcs Additional source files to include in generated Prost source code. List of labels optional [] prost_opts Additional options to add to Prost. List of strings optional [] tonic_opts Additional options to add to Tonic. List of strings optional []","breadcrumbs":"Extensions » prost » rust_prost_transform","id":"156","title":"rust_prost_transform"},"157":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using rust-protobuf .","breadcrumbs":"Extensions » protobuf » rules_rust_protobuf","id":"157","title":"rules_rust_protobuf"},"158":{"body":"To use the Rust proto rules, add the following to your WORKSPACE file to add the external repositories for the Rust proto toolchain (in addition to the rust rules setup ): load(\"@rules_rust//proto/protobuf:repositories.bzl\", \"rust_proto_protobuf_dependencies\", \"rust_proto_protobuf_register_toolchains\") rust_proto_protobuf_dependencies() rust_proto_protobuf_register_toolchains() load(\"@rules_rust//proto/protobuf:transitive_repositories.bzl\", \"rust_proto_protobuf_transitive_repositories\") rust_proto_protobuf_transitive_repositories() This will load the required dependencies for the rust-protobuf rules. It will also register a default toolchain for the rust_proto_library and rust_grpc_library rules. To customize the rust_proto_library and rust_grpc_library toolchain, please see the section Customizing rust-protobuf Dependencies . For additional information about Bazel toolchains, see here . Customizing rust-protobuf Dependencies These rules depend on the protobuf and the grpc crates in addition to the protobuf compiler . To obtain these crates, rust_proto_repositories imports the given crates using BUILD files generated with crate_universe . If you want to either change the protobuf and gRPC rust compilers, or to simply use crate_universe in a more complex scenario (with more dependencies), you must redefine those dependencies. To do this, once you've imported the needed dependencies (see our @rules_rust//proto/protobuf/3rdparty/BUILD.bazel file to see the default dependencies), you need to create your own toolchain. To do so you can create a BUILD file with your toolchain definition, for example: load(\"@rules_rust//proto:toolchain.bzl\", \"rust_proto_toolchain\") rust_proto_toolchain( name = \"proto-toolchain-impl\", # Path to the protobuf compiler. protoc = \"@com_google_protobuf//:protoc\", # Protobuf compiler plugin to generate rust gRPC stubs. grpc_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust_grpc\", # Protobuf compiler plugin to generate rust protobuf stubs. proto_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust\",\n) toolchain( name = \"proto-toolchain\", toolchain = \":proto-toolchain-impl\", toolchain_type = \"@rules_rust//proto/protobuf:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:proto-toolchain\") Finally, you might want to set the rust_deps attribute in rust_proto_library and rust_grpc_library to change the compile-time dependencies: rust_proto_library( ... rust_deps = [\"//3rdparty/crates:protobuf\"], ...\n) rust_grpc_library( ... rust_deps = [ \"//3rdparty/crates:protobuf\", \"//3rdparty/crates:grpc\", \"//3rdparty/crates:tls_api\", \"//3rdparty/crates:tls_api_stub\", ], ...\n) Note : Ideally, we would inject those dependencies from the toolchain, but due to bazelbuild/bazel#6889 all dependencies added via the toolchain ends-up being in the wrong configuration.","breadcrumbs":"Extensions » protobuf » Setup","id":"158","title":"Setup"},"159":{"body":"rust_grpc_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys suitable for gRPC. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_grpc_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_grpc_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_service\", srcs = [\"my_service.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding gRPC stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_grpc_library","id":"159","title":"rust_grpc_library"},"16":{"body":"rust_binary(name, deps, srcs, data, aliases, alwayslink, binary_name, compile_data, crate_features, crate_name, crate_root, crate_type, edition, env, experimental_use_cc_common_link, linker_script, malloc, out_binary, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust binary crate. Example: Suppose you have the following directory structure for a Rust project with a library crate, hello_lib, and a binary crate, hello_world that uses the hello_lib library: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_world/ BUILD src/ main.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) hello_world/src/main.rs: extern crate hello_lib; fn main() { let hello = hello_lib::Greeter::new(\"Hello\"); hello.greet(\"world\");\n} hello_world/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_binary\") rust_binary( name = \"hello_world\", srcs = [\"src/main.rs\"], deps = [\"//hello_lib\"],\n) Build and run hello_world: $ bazel run //hello_world\nINFO: Found 1 target...\nTarget //examples/rust/hello_world:hello_world up-to-date:\nbazel-bin/examples/rust/hello_world/hello_world\nINFO: Elapsed time: 1.308s, Critical Path: 1.22s INFO: Running command line: bazel-bin/examples/rust/hello_world/hello_world\nHello world On Windows, a PDB file containing debugging information is available under the key pdb_file in OutputGroupInfo. Similarly on macOS, a dSYM folder is available under the key dsym_folder in OutputGroupInfo. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False binary_name Override the resulting binary file name. By default, the binary file will be named using the name attribute on this rule, however sometimes that is not deseriable. String optional \"\" compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None crate_type Crate type that will be passed to rustc to be used for building this crate.This option is a temporary workaround and should be used only when building for WebAssembly targets (//rust/platform:wasi and //rust/platform:wasm). String optional \"bin\" edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the target is executed by bazel run. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution.Execpath returns absolute path, and in order to be able to construct the absolute path we need to wrap the test binary in a launcher. Using a launcher comes with complications, such as more complicated debugger attachment. Dictionary: String -> String optional {} experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 linker_script Link script to forward into linker via rustc options. Label optional None malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" out_binary Force a target, regardless of it's crate_type, to always mark the file as executable. This attribute is only used to support wasm targets but is expected to be removed following a resolution to https://github.com/bazelbuild/rules_rust/issues/771. Boolean optional False platform Optional platform to transition the binary to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional -1 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_binary","id":"16","title":"rust_binary"},"160":{"body":"rust_proto_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_proto_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_proto_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_proto_binary\", srcs = [\"my_proto_binary.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_proto_library","id":"160","title":"rust_proto_library"},"161":{"body":"Bazel rules for generating wasm modules for Javascript using wasm-bindgen .","breadcrumbs":"Extensions » wasm_bindgen » rules_rust_wasm_bindgen","id":"161","title":"rules_rust_wasm_bindgen"},"162":{"body":"rust_wasm_bindgen rust_wasm_bindgen_toolchain","breadcrumbs":"Extensions » wasm_bindgen » Rules","id":"162","title":"Rules"},"163":{"body":"To begin using the wasm-bindgen rules, users can load the necessary dependencies in their workspace by adding the following to their WORKSPACE.bazel file. load(\"@rules_rust_wasm_bindgen//:repositories.bzl\", \"rust_wasm_bindgen_dependencies\", \"rust_wasm_bindgen_register_toolchains\") rust_wasm_bindgen_dependencies() rust_wasm_bindgen_register_toolchains() This should enable users to start using the rust_wasm_bindgen rule. However, it's common to want to control the version of wasm-bindgen in the workspace instead of relying on the one provided by rules_rust. In this case, users should avoid calling rust_wasm_bindgen_register_toolchains and instead use the rust_wasm_bindgen_toolchain rule to define their own toolchains to register in the workspace.","breadcrumbs":"Extensions » wasm_bindgen » Setup","id":"163","title":"Setup"},"164":{"body":"While it's recommended for users to mantain their own , in the @rules_rust_wasm_bindgen package there exists interface sub-packages for various Javascript Bazel rules. E.g. aspect_rules_js. The rules defined there are a more convenient way to use rust_wasm_bindgen with the associated javascript rules due to the inclusion of additional providers. Each directory contains a defs.bzl file that defines the different variants of rust_wasm_bindgen. (e.g. js_rust_wasm_bindgen for the rules_js submodule).","breadcrumbs":"Extensions » wasm_bindgen » Interfacing with Javascript rules","id":"164","title":"Interfacing with Javascript rules"},"165":{"body":"rust_wasm_bindgen(name, bindgen_flags, out_name, target, target_arch, wasm_file) Generates javascript and typescript bindings for a webassembly module using wasm-bindgen . An example of this rule in use can be seen at @rules_rust//examples/wasm ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the wasm-bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details. List of strings optional [] out_name Set a custom output filename (Without extension. Defaults to target name). String optional \"\" target The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details. String optional \"bundler\" target_arch The target architecture to use for the wasm-bindgen command line option. String optional \"wasm32\" wasm_file The .wasm file or crate to generate bindings for. Label required","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen","id":"165","title":"rust_wasm_bindgen"},"166":{"body":"rust_wasm_bindgen_toolchain(name, bindgen) The tools required for the rust_wasm_bindgen rule. In cases where users want to control or change the version of wasm-bindgen used by rust_wasm_bindgen , a unique toolchain can be created as in the example below: load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( bindgen = \"//3rdparty/crates:wasm_bindgen_cli__bin\",\n) toolchain( name = \"wasm_bindgen_toolchain\", toolchain = \"wasm_bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_wasm_bindgen//:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:wasm_bindgen_toolchain\") For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a wasm-bindgen-cli executable. Label optional None","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen_toolchain","id":"166","title":"rust_wasm_bindgen_toolchain"},"167":{"body":"RustWasmBindgenInfo(js, ts, wasm) Info about wasm-bindgen outputs. FIELDS Name Description js Depset[File]: The Javascript files produced by wasm-bindgen. ts Depset[File]: The Typescript files produced by wasm-bindgen. wasm File: The .wasm file generated by wasm-bindgen.","breadcrumbs":"Extensions » wasm_bindgen » RustWasmBindgenInfo","id":"167","title":"RustWasmBindgenInfo"},"17":{"body":"rust_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, disable_pipelining, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust library crate. Example: Suppose you have the following directory structure for a simple Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ greeter.rs lib.rs hello_lib/src/greeter.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/src/lib.rs: pub mod greeter; hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [ \"src/greeter.rs\", \"src/lib.rs\", ],\n) Build the library: $ bazel build //hello_lib\nINFO: Found 1 target...\nTarget //examples/rust/hello_lib:hello_lib up-to-date:\nbazel-bin/examples/rust/hello_lib/libhello_lib.rlib\nINFO: Elapsed time: 1.245s, Critical Path: 1.01s ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None disable_pipelining Disables pipelining for this rule if it is globally enabled. This will cause this rule to not produce a .rmeta file and all the dependent crates will instead use the .rlib file. Boolean optional False edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_library","id":"17","title":"rust_library"},"18":{"body":"rust_library_group(name, deps) Functions as an alias for a set of dependencies. Specifically, the following are equivalent: rust_library_group( name = \"crate_group\", deps = [ \":crate1\", \":crate2\", ],\n) rust_library( name = \"foobar\", deps = [\":crate_group\"], ...\n) and rust_library( name = \"foobar\", deps = [ \":crate1\", \":crate2\", ], ...\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Other dependencies to forward through this crate group. List of labels optional []","breadcrumbs":"Rules » rust » rust_library_group","id":"18","title":"rust_library_group"},"19":{"body":"rust_proc_macro(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust proc-macro crate. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_proc_macro","id":"19","title":"rust_proc_macro"},"2":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust\", version = \"0.48.0\") Don't forget to substitute in your desired release's version number.","breadcrumbs":"Introduction » Bzlmod","id":"2","title":"Bzlmod"},"20":{"body":"rust_shared_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust shared library. This shared library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce a shared library that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the shared library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_shared_library","id":"20","title":"rust_shared_library"},"21":{"body":"rust_static_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust static library. This static library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce an archive that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" platform Optional platform to transition the static library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_static_library","id":"21","title":"rust_static_library"},"22":{"body":"rust_test(name, deps, srcs, data, aliases, alwayslink, compile_data, crate, crate_features, crate_name, crate_root, edition, env, env_inherit, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, use_libtest_harness, version) Builds a Rust test crate. Examples: Suppose you have the following directory structure for a Rust library crate with unit test code in the library sources: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) -> String { format!(\"{} {}\", &self.greeting, thing) }\n} #[cfg(test)]\nmod test { use super::Greeter; #[test] fn test_greeting() { let hello = Greeter::new(\"Hi\"); assert_eq!(\"Hi Rust\", hello.greet(\"Rust\")); }\n} To build and run the tests, simply add a rust_test rule with no srcs and only depends on the hello_lib rust_library target via the crate attribute: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"hello_lib_test\", crate = \":hello_lib\", # You may add other deps that are specific to the test configuration deps = [\"//some/dev/dep\"],\n) Run the test with bazel test //hello_lib:hello_lib_test.","breadcrumbs":"Rules » rust » rust_test","id":"22","title":"rust_test"},"23":{"body":"Integration tests that live in the tests directory , they are essentially built as separate crates. Suppose you have the following directory structure where greeting.rs is an integration test for the hello_lib library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs tests/ greeting.rs hello_lib/tests/greeting.rs: extern crate hello_lib; use hello_lib; #[test]\nfn test_greeting() { let hello = greeter::Greeter::new(\"Hello\"); assert_eq!(\"Hello world\", hello.greeting(\"world\"));\n} To build the greeting.rs integration test, simply add a rust_test target with greeting.rs in srcs and a dependency on the hello_lib target: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"greeting_test\", srcs = [\"tests/greeting.rs\"], deps = [\":hello_lib\"],\n) Run the test with bazel test //hello_lib:greeting_test. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate Target inline tests declared in the given crateThese tests are typically those that would be held out under #[cfg(test)] declarations. Label optional None crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the test is executed by bazel test. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution. Dictionary: String -> String optional {} env_inherit Specifies additional environment variables to inherit from the external environment when the test is executed by bazel test. List of strings optional [] experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the test to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 use_libtest_harness Whether to use libtest. For targets using this flag, individual tests can be run by using the --test_arg flag. E.g. bazel test //src:rust_test --test_arg=foo::test::test_fn. Boolean optional True version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » Example: test directory","id":"23","title":"Example: test directory"},"24":{"body":"rust_test_suite(name, srcs, shared_srcs, kwargs) A rule for creating a test suite for a set of rust_test targets. This rule can be used for setting up typical rust integration tests . Given the following directory structure: [crate]/ BUILD.bazel src/ lib.rs main.rs tests/ integrated_test_a.rs integrated_test_b.rs integrated_test_c.rs patterns/ fibonacci_test.rs helpers/ mod.rs The rule can be used to generate rust_test targets for each source file under tests and a test_suite which encapsulates all tests. load(\"//rust:defs.bzl\", \"rust_binary\", \"rust_library\", \"rust_test_suite\") rust_library( name = \"math_lib\", srcs = [\"src/lib.rs\"],\n) rust_binary( name = \"math_bin\", srcs = [\"src/main.rs\"],\n) rust_test_suite( name = \"integrated_tests_suite\", srcs = glob([\"tests/**\"]), shared_srcs=glob([\"tests/helpers/**\"]), deps = [\":math_lib\"],\n) PARAMETERS Name Description Default Value name The name of the test_suite. none srcs All test sources, typically glob([\"tests/**/*.rs\"]). none shared_srcs Optional argument for sources shared among tests, typically helper functions. [] kwargs Additional keyword arguments for the underyling rust_test targets. The tags argument is also passed to the generated test_suite target. none","breadcrumbs":"Rules » rust » rust_test_suite","id":"24","title":"rust_test_suite"},"25":{"body":"rust_doc rust_doc_test","breadcrumbs":"Rules » rustdoc » Rust Doc","id":"25","title":"Rust Doc"},"26":{"body":"rust_doc(name, crate, html_after_content, html_before_content, html_in_header, markdown_css, rustc_flags, rustdoc_flags) Generates code documentation. Example: Suppose you have the following directory structure for a Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs To build rustdoc documentation for the hello_lib crate, define a rust_doc rule that depends on the the hello_lib rust_library target: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_doc\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_doc( name = \"hello_lib_doc\", crate = \":hello_lib\",\n) Running bazel build //hello_lib:hello_lib_doc will build a zip file containing the documentation for the hello_lib library crate generated by rustdoc. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required crate The label of the target to generate code documentation for.rust_doc can generate HTML code documentation for the source files of rust_library or rust_binary targets. Label required html_after_content File to add in , after content. Label optional None html_before_content File to add in , before content. Label optional None html_in_header File to add to . Label optional None markdown_css CSS files to include via :' that takes a single label parameter 'actual'. See '@crate_index//:alias_rules.bzl' for an example. \"alias\" default_package_name The default package name to use in the rendered macros. This affects the auto package detection of things like all_crate_deps. None generate_target_compatible_with Whether to generate target_compatible_with annotations on the generated BUILD files. This catches a target_triplebeing targeted that isn't declared in supported_platform_triples. True platforms_template The base template to use for platform names. See platforms documentation . The available format keys are [{triple}]. \"@rules_rust//rust/platform:{triple}\" regen_command An optional command to demonstrate how generated files should be regenerated. None vendor_mode An optional configuration for rendirng content to be rendered into repositories. None generate_rules_license_metadata Whether to generate rules license metedata False RETURNS string: A json encoded struct to match the Rust config::RenderConfig struct","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » render_config","id":"128","title":"render_config"},"129":{"body":"splicing_config(resolver_version) Various settings used to configure Cargo manifest splicing behavior. PARAMETERS Name Description Default Value resolver_version The resolver version to use in generated Cargo manifests. This flag is only used when splicing a manifest from direct package definitions. See crates_repository::packages. \"2\" RETURNS str: A json encoded string of the parameters provided","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » splicing_config","id":"129","title":"splicing_config"},"13":{"body":"error_format(name) Change the --error-format flag from the command line with --@rules_rust//rust/settings:error_format. See rustc documentation for valid values. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » error_format","id":"13","title":"error_format"},"130":{"body":"crates_repository(name, annotations, cargo_config, cargo_lockfile, compressed_windows_toolchain_names, generate_binaries, generate_build_scripts, generate_target_compatible_with, generator, generator_sha256s, generator_urls, isolated, lockfile, manifests, packages, quiet, render_config, repin_instructions, repo_mapping, rust_toolchain_cargo_template, rust_toolchain_rustc_template, rust_version, splicing_config, supported_platform_triples) A rule for defining and downloading Rust dependencies (crates). This rule handles all the same workflows crate_universe rules do. Environment Variables: variable usage CARGO_BAZEL_GENERATOR_SHA256 The sha256 checksum of the file located at CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_URL The URL of a cargo-bazel binary. This variable takes precedence over attributes and can use file:// for local paths CARGO_BAZEL_ISOLATED An authorative flag as to whether or not the CARGO_HOME environment variable should be isolated from the host configuration CARGO_BAZEL_REPIN An indicator that the dependencies represented by the rule should be regenerated. REPIN may also be used. See Repinning / Updating Dependencies for more details. CARGO_BAZEL_REPIN_ONLY A comma-delimited allowlist for rules to execute repinning. Can be useful if multiple instances of the repository rule are used in a Bazel workspace, but repinning should be limited to one of them. Example: Given the following workspace structure: [workspace]/ WORKSPACE.bazel BUILD.bazel Cargo.toml Cargo.Bazel.lock src/ main.rs The following is something that'd be found in the WORKSPACE file: load(\"@rules_rust//crate_universe:defs.bzl\", \"crates_repository\", \"crate\") crates_repository( name = \"crate_index\", annotations = { \"rand\": [crate.annotation( default_features = False, features = [\"small_rng\"], )], }, cargo_lockfile = \"//:Cargo.Bazel.lock\", lockfile = \"//:cargo-bazel-lock.json\", manifests = [\"//:Cargo.toml\"], # Should match the version represented by the currently registered `rust_toolchain`. rust_version = \"1.60.0\",\n) The above will create an external repository which contains aliases and macros for accessing Rust targets found in the dependency graph defined by the given manifests. NOTE : The cargo_lockfile and lockfile must be manually created. The rule unfortunately does not yet create it on its own. When initially setting up this rule, an empty file should be created and then populated by repinning dependencies.","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » crates_repository","id":"130","title":"crates_repository"},"131":{"body":"Dependency syncing and updating is done in the repository rule which means it's done during the analysis phase of builds. As mentioned in the environments variable table above, the CARGO_BAZEL_REPIN (or REPIN) environment variables can be used to force the rule to update dependencies and potentially render a new lockfile. Given an instance of this repository rule named crate_index, the easiest way to repin dependencies is to run: CARGO_BAZEL_REPIN=1 bazel sync --only=crate_index This will result in all dependencies being updated for a project. The CARGO_BAZEL_REPIN environment variable can also be used to customize how dependencies are updated. The following table shows translations from environment variable values to the equivilant cargo update command that is called behind the scenes to update dependencies. Value Cargo command Any of [true, 1, yes, on, workspace] cargo update --workspace Any of [full, eager, all] cargo update package_name cargo upgrade --package package_name package_name@1.2.3 cargo upgrade --package package_name@1.2.3 package_name@1.2.3=4.5.6 cargo upgrade --package package_name@1.2.3 --precise=4.5.6 If the crates_repository is used multiple times in the same Bazel workspace (e.g. for multiple independent Rust workspaces), it may additionally be useful to use the CARGO_BAZEL_REPIN_ONLY environment variable, which limits execution of the repinning to one or multiple instances of the crates_repository rule via a comma-delimited allowlist: CARGO_BAZEL_REPIN=1 CARGO_BAZEL_REPIN_ONLY=crate_index bazel sync --only=crate_index ATTRIBUTES Name Description Type Mandatory Default name A unique name for this repository. Name required annotations Extra settings to apply to crates. See crate.annotation . Dictionary: String -> List of strings optional {} cargo_config A Cargo configuration file Label optional None cargo_lockfile The path used to store the crates_repository specific Cargo.lock file. In the case that your crates_repository corresponds directly with an existing Cargo.toml file which has a paired Cargo.lock file, that Cargo.lock file should be used here, which will keep the versions used by cargo and bazel in sync. Label required compressed_windows_toolchain_names Wether or not the toolchain names of windows toolchains are expected to be in a compressed format. Boolean optional True generate_binaries Whether to generate rust_binary targets for all the binary crates in every package. By default only the rust_library targets are generated. Boolean optional False generate_build_scripts Whether or not to generate cargo build scripts by default. Boolean optional True generate_target_compatible_with DEPRECATED: Moved to render_config. Boolean optional True generator The absolute label of a generator. Eg. @cargo_bazel_bootstrap//:cargo-bazel. This is typically used when bootstrapping String optional \"\" generator_sha256s Dictionary of host_triple -> sha256 for a cargo-bazel binary. Dictionary: String -> String optional {} generator_urls URL template from which to download the cargo-bazel binary. {host_triple} and will be filled in according to the host platform. Dictionary: String -> String optional {} isolated If true, CARGO_HOME will be overwritten to a directory within the generated repository in order to prevent other uses of Cargo from impacting having any effect on the generated targets produced by this rule. For users who either have multiple crate_repository definitions in a WORKSPACE or rapidly re-pin dependencies, setting this to false may improve build times. This variable is also controled by CARGO_BAZEL_ISOLATED environment variable. Boolean optional True lockfile The path to a file to use for reproducible renderings. If set, this file must exist within the workspace (but can be empty) before this rule will work. Label optional None manifests A list of Cargo manifests (Cargo.toml files). List of labels optional [] packages A set of crates (packages) specifications to depend on. See crate.spec . Dictionary: String -> String optional {} quiet If stdout and stderr should not be printed to the terminal. Boolean optional True render_config The configuration flags to use for rendering. Use //crate_universe:defs.bzl\\%render_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" repin_instructions Instructions to re-pin the repository if required. Many people have wrapper scripts for keeping dependencies up to date, and would like to point users to that instead of the default. String optional \"\" repo_mapping In WORKSPACE context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.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).This attribute is not supported in MODULE.bazel context (when invoking a repository rule inside a module extension's implementation function). Dictionary: String -> String optional rust_toolchain_cargo_template The template to use for finding the host cargo binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'rustc.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_toolchain_rustc_template The template to use for finding the host rustc binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {cfg} (eg. 'exec'), {channel} (eg. 'stable'), and {tool} (eg. 'cargo.exe') will be replaced in the string if present. String optional \"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}\" rust_version The version of Rust the currently registered toolchain is using. Eg. 1.56.0, or nightly/2021-09-08 String optional \"1.83.0\" splicing_config The configuration flags to use for splicing Cargo maniests. Use //crate_universe:defs.bzl\\%rsplicing_config to generate the value for this field. If unset, the defaults defined there will be used. String optional \"\" supported_platform_triples A set of all platform triples to consider when generating dependencies. List of strings optional [\"aarch64-apple-darwin\", \"aarch64-apple-ios\", \"aarch64-apple-ios-sim\", \"aarch64-linux-android\", \"aarch64-pc-windows-msvc\", \"aarch64-unknown-fuchsia\", \"aarch64-unknown-linux-gnu\", \"aarch64-unknown-nixos-gnu\", \"aarch64-unknown-nto-qnx710\", \"arm-unknown-linux-gnueabi\", \"armv7-linux-androideabi\", \"armv7-unknown-linux-gnueabi\", \"i686-apple-darwin\", \"i686-linux-android\", \"i686-pc-windows-msvc\", \"i686-unknown-freebsd\", \"i686-unknown-linux-gnu\", \"powerpc-unknown-linux-gnu\", \"riscv32imc-unknown-none-elf\", \"riscv64gc-unknown-none-elf\", \"s390x-unknown-linux-gnu\", \"thumbv7em-none-eabi\", \"thumbv8m.main-none-eabi\", \"wasm32-unknown-unknown\", \"wasm32-wasip1\", \"x86_64-apple-darwin\", \"x86_64-apple-ios\", \"x86_64-linux-android\", \"x86_64-pc-windows-msvc\", \"x86_64-unknown-freebsd\", \"x86_64-unknown-fuchsia\", \"x86_64-unknown-linux-gnu\", \"x86_64-unknown-nixos-gnu\", \"x86_64-unknown-none\"] ENVIRONMENT VARIABLES This repository rule depends on the following environment variables: CARGO_BAZEL_GENERATOR_URL CARGO_BAZEL_GENERATOR_SHA256 CARGO_BAZEL_REPIN REPIN CARGO_BAZEL_REPIN_ONLY CARGO_BAZEL_ISOLATED CARGO_BAZEL_DEBUG","breadcrumbs":"External Crates » crate_universe (WORKSPACE) » Repinning / Updating Dependencies","id":"131","title":"Repinning / Updating Dependencies"},"132":{"body":"rules_rust manages versions of things like rustc. If you want to manually run upstream tooling configured at the versions, plugins and such that rules_rust has configured, rules_rust exposes these as targets in @rules_rust//tools/upstream_wrapper: % bazel query @rules_rust//tools/upstream_wrapper\n@rules_rust//tools/upstream_wrapper:cargo\n@rules_rust//tools/upstream_wrapper:cargo_clippy\n@rules_rust//tools/upstream_wrapper:rustc\n@rules_rust//tools/upstream_wrapper:rustfmt You can run them via bazel run, e.g. bazel run @rules_rust//tools/upstream_wrapper:cargo -- check.","breadcrumbs":"Upstream Tooling » Upstream Tooling","id":"132","title":"Upstream Tooling"},"133":{"body":"Bazel rules for interfacing with other rules and integrations with popular 3rd party tools.","breadcrumbs":"Extensions » Extensions","id":"133","title":"Extensions"},"134":{"body":"The extension rules are released with each release of rules_rust (core) which can be found on the GitHub Releases page . We recommend using the latest release from that page.","breadcrumbs":"Extensions » Setup","id":"134","title":"Setup"},"135":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust extensions in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust_{EXTENSION}\", version = \"{VERSION}\") Don't forget to substitute in your desired release's version number and {EXTENSION} with the name of the desired extension. E.g.: bazel_dep(name = \"rules_rust_bindgen\", version = \"0.55.0\")","breadcrumbs":"Extensions » Bzlmod","id":"135","title":"Bzlmod"},"136":{"body":"To use rules_rust extensions in a project using a WORKSPACE file, add the following to your WORKSPACE file to add the external repositories for the Rust toolchain: load(\"@bazel_tools//tools/build_defs/repo:http.bzl\", \"http_archive\") # To find additional information on this release or newer ones visit:\n# https://github.com/bazelbuild/rules_rust/releases\nhttp_archive( name = \"rules_rust_{EXTENSION}\", # See releases page\n) # Refer to the documentation of the desired rules for how to load other necessary dependencies. Don't forget to substitute in your desired release's version number, integrity hash, and {EXTENSION} with the name of the desired extension.","breadcrumbs":"Extensions » WORKSPACE","id":"136","title":"WORKSPACE"},"137":{"body":"These rules are for using Bindgen to generate Rust bindings to C (and some C++) libraries.","breadcrumbs":"Extensions » bindgen » rules_rust_bindgen","id":"137","title":"rules_rust_bindgen"},"138":{"body":"rust_bindgen rust_bindgen_library rust_bindgen_toolchain","breadcrumbs":"Extensions » bindgen » Rules","id":"138","title":"Rules"},"139":{"body":"To use the Rust bindgen rules, add the following to your WORKSPACE file to add the external repositories for the Rust bindgen toolchain (in addition to the rust rules setup ): load(\"@rules_rust_bindgen//:repositories.bzl\", \"rust_bindgen_dependencies\", \"rust_bindgen_register_toolchains\") rust_bindgen_dependencies() rust_bindgen_register_toolchains() load(\"@rules_rust_bindgen//:transitive_repositories.bzl\", \"rust_bindgen_transitive_dependencies\") rust_bindgen_transitive_dependencies() Bindgen aims to be as hermetic as possible so will end up building libclang from llvm-project from source. If this is found to be undesirable then no Bindgen related calls should be added to your WORKSPACE and instead users should define their own repositories using something akin to crate_universe and define their own toolchains following the instructions for rust_bindgen_toolchain .","breadcrumbs":"Extensions » bindgen » Setup","id":"139","title":"Setup"},"14":{"body":"extra_rustc_flag(name) Add additional rustc_flag from the command line with --@rules_rust//rust/settings:extra_rustc_flag. Multiple uses are accumulated and appended after the extra_rustc_flags. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flag","id":"14","title":"extra_rustc_flag"},"140":{"body":"rust_bindgen(name, bindgen_flags, cc_lib, clang_flags, header, merge_cc_lib_objects_into_rlib, wrap_static_fns) Generates a rust source file from a cc_library and a header. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. List of strings optional [] cc_lib The cc_library that contains the .h file. This is used to find the transitive includes. Label required clang_flags Flags to pass directly to the clang executable. List of strings optional [] header The .h file to generate bindings for. Label required merge_cc_lib_objects_into_rlib When True, objects from cc_lib will be copied into the rlib archive produced by the rust_library that depends on this rust_bindgen rule (using BuildInfo provider) Boolean optional True wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains). Boolean optional False","breadcrumbs":"Extensions » bindgen » rust_bindgen","id":"140","title":"rust_bindgen"},"141":{"body":"rust_bindgen_toolchain(name, bindgen, clang, default_rustfmt, libclang, libstdcxx) The tools required for the rust_bindgen rule. This rule depends on the bindgen binary crate, and it in turn depends on both a clang binary and the clang library. To obtain these dependencies, rust_bindgen_dependencies imports bindgen and its dependencies. load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( name = \"bindgen_toolchain_impl\", bindgen = \"//my/rust:bindgen\", clang = \"//my/clang:clang\", libclang = \"//my/clang:libclang.so\", libstdcxx = \"//my/cpp:libstdc++\",\n) toolchain( name = \"bindgen_toolchain\", toolchain = \"bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_bindgen//:toolchain_type\",\n) This toolchain will then need to be registered in the current WORKSPACE. For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a bindgen executable. Label optional None clang The label of a clang executable. Label optional None default_rustfmt If set, rust_bindgen targets will always format generated sources with rustfmt. Boolean optional True libclang A cc_library that provides bindgen's runtime dependency on libclang. Label optional None libstdcxx A cc_library that satisfies libclang's libstdc++ dependency. This is used to make the execution of clang hermetic. If None, system libraries will be used instead. Label optional None","breadcrumbs":"Extensions » bindgen » rust_bindgen_toolchain","id":"141","title":"rust_bindgen_toolchain"},"142":{"body":"rust_bindgen_library(name, header, cc_lib, bindgen_flags, bindgen_features, clang_flags, wrap_static_fns, kwargs) Generates a rust source file for header, and builds a rust_library. Arguments are the same as rust_bindgen, and kwargs are passed directly to rust_library. PARAMETERS Name Description Default Value name A unique name for this target. none header The label of the .h file to generate bindings for. none cc_lib The label of the cc_library that contains the .h file. This is used to find the transitive includes. none bindgen_flags Flags to pass directly to the bindgen executable. See https://rust-lang.github.io/rust-bindgen/ for details. None bindgen_features The features attribute for the rust_bindgen target. None clang_flags Flags to pass directly to the clang executable. None wrap_static_fns Whether to create a separate .c file for static fns. Requires nightly toolchain, and a header that actually needs this feature (otherwise bindgen won't generate the file and Bazel complains\", False kwargs Arguments to forward to the underlying rust_library rule. none","breadcrumbs":"Extensions » bindgen » rust_bindgen_library","id":"142","title":"rust_bindgen_library"},"143":{"body":"Bazel rules for mdBook .","breadcrumbs":"Extensions » mdbook » rules_rust_mdbook","id":"143","title":"rules_rust_mdbook"},"144":{"body":"mdbook mdbook_server mdbook_toolchain","breadcrumbs":"Extensions » mdbook » Rules","id":"144","title":"Rules"},"145":{"body":"","breadcrumbs":"Extensions » mdbook » Setup","id":"145","title":"Setup"},"146":{"body":"bazel_dep(name = \"rules_rust_mdbook\", version = \"{SEE_RELEASE_NOTES}\")","breadcrumbs":"Extensions » mdbook » bzlmod","id":"146","title":"bzlmod"},"147":{"body":"load(\"@rules_rust_mdbook//:repositories.bzl\", \"mdbook_register_toolchains\", \"rules_mdbook_dependencies\") rules_mdbook_dependencies() mdbook_register_toolchains() load(\"@rules_rust_mdbook//:repositories_transitive.bzl\", \"rules_mdbook_transitive_deps\") rules_mdbook_transitive_deps()","breadcrumbs":"Extensions » mdbook » WORKSPACE","id":"147","title":"WORKSPACE"},"148":{"body":"mdbook(name, srcs, book, plugins) Rules to create book from markdown files using mdBook. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required srcs All inputs to the book. List of labels optional [] book The book.toml file. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook","id":"148","title":"mdbook"},"149":{"body":"mdbook_server(name, book, hostname, port) Spawn an mdbook server for a given mdbook target. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required book The mdbook target to serve. Label required hostname The default hostname to use (Can be overridden on the command line). String optional \"localhost\" port The default port to use (Can be overridden on the command line). String optional \"3000\"","breadcrumbs":"Extensions » mdbook » mdbook_server","id":"149","title":"mdbook_server"},"15":{"body":"extra_rustc_flags(name) Add additional rustc_flags from the command line with --@rules_rust//rust/settings:extra_rustc_flags. This flag should only be used for flags that need to be applied across the entire build. For options that apply to individual crates, use the rustc_flags attribute on the individual crate's rule instead. NOTE: These flags not applied to the exec configuration (proc-macros, cargo_build_script, etc); use --@rules_rust//rust/settings:extra_exec_rustc_flags to apply flags to the exec configuration. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required","breadcrumbs":"Rules » rust » extra_rustc_flags","id":"15","title":"extra_rustc_flags"},"150":{"body":"mdbook_toolchain(name, mdbook, plugins) A mdBook toolchain. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required mdbook A mdBook binary. Label required plugins Executables to inject into PATH for use in preprocessor commands . List of labels optional []","breadcrumbs":"Extensions » mdbook » mdbook_toolchain","id":"150","title":"mdbook_toolchain"},"151":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using Prost and Tonic","breadcrumbs":"Extensions » prost » rules_rust_prost","id":"151","title":"rules_rust_prost"},"152":{"body":"rust_prost_library rust_prost_toolchain","breadcrumbs":"Extensions » prost » Rules","id":"152","title":"Rules"},"153":{"body":"load(\"@rules_rust//proto/prost:repositories.bzl\", \"rust_prost_dependencies\") rust_prost_dependencies() load(\"@rules_rust//proto/prost:transitive_repositories.bzl\", \"rust_prost_transitive_repositories\") rust_prost_transitive_repositories() The prost and tonic rules do not specify a default toolchain in order to avoid mismatched dependency issues. To setup the prost and tonic toolchain, please see the section Customizing prost and tonic Dependencies . For additional information about Bazel toolchains, see here . Customizing prost and tonic Dependencies These rules depend on the prost and tonic dependencies. To setup the necessary toolchain for these rules, you must define a toolchain with the prost , prost-types , tonic , protoc-gen-prost , and protoc-gen-tonic crates as well as the protoc binary. To get access to these crates, you can use the crate_universe repository rules. For example: load(\"//crate_universe:defs.bzl\", \"crate\", \"crates_repository\") crates_repository( name = \"crates_io\", annotations = { \"protoc-gen-prost\": [crate.annotation( gen_binaries = [\"protoc-gen-prost\"], patch_args = [ \"-p1\", ], patches = [ # Note: You will need to use this patch until a version greater than `0.2.2` of # `protoc-gen-prost` is released. \"@rules_rust//proto/prost/private/3rdparty/patches:protoc-gen-prost.patch\", ], )], \"protoc-gen-tonic\": [crate.annotation( gen_binaries = [\"protoc-gen-tonic\"], )], }, cargo_lockfile = \"Cargo.Bazel.lock\", mode = \"remote\", packages = { \"prost\": crate.spec( version = \"0\", ), \"prost-types\": crate.spec( version = \"0\", ), \"protoc-gen-prost\": crate.spec( version = \"0\", ), \"protoc-gen-tonic\": crate.spec( version = \"0\", ), \"tonic\": crate.spec( version = \"0\", ), }, repository_name = \"rules_rust_prost\", tags = [\"manual\"],\n) You can then define a toolchain with the rust_prost_toolchain rule which uses the crates defined above. For example: load(\"@rules_rust//proto/prost:defs.bzl\", \"rust_prost_toolchain\")\nload(\"@rules_rust//rust:defs.bzl\", \"rust_library_group\") rust_library_group( name = \"prost_runtime\", deps = [ \"@crates_io//:prost\", ],\n) rust_library_group( name = \"tonic_runtime\", deps = [ \":prost_runtime\", \"@crates_io//:tonic\", ],\n) rust_prost_toolchain( name = \"prost_toolchain_impl\", prost_plugin = \"@crates_io//:protoc-gen-prost__protoc-gen-prost\", prost_runtime = \":prost_runtime\", prost_types = \"@crates_io//:prost-types\", proto_compiler = \"@com_google_protobuf//:protoc\", tonic_plugin = \"@crates_io//:protoc-gen-tonic__protoc-gen-tonic\", tonic_runtime = \":tonic_runtime\",\n) toolchain( name = \"prost_toolchain\", toolchain = \"prost_toolchain_impl\", toolchain_type = \"@rules_rust//proto/prost:toolchain_type\",\n) Lastly, you must register the toolchain in your WORKSPACE file. For example: register_toolchains(\"//toolchains:prost_toolchain\")","breadcrumbs":"Extensions » prost » Setup","id":"153","title":"Setup"},"154":{"body":"rust_prost_library(name, proto) A rule for generating a Rust library using Prost. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required proto A proto_library target for which to generate Rust gencode. Label required","breadcrumbs":"Extensions » prost » rust_prost_library","id":"154","title":"rust_prost_library"},"155":{"body":"rust_prost_toolchain(name, include_transitive_deps, prost_opts, prost_plugin, prost_plugin_flag, prost_runtime, prost_types, proto_compiler, tonic_opts, tonic_plugin, tonic_plugin_flag, tonic_runtime) Rust Prost toolchain rule. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required include_transitive_deps Whether to include transitive dependencies. If set to True, all transitive dependencies will directly accessible by the dependent crate. Boolean optional False prost_opts Additional options to add to Prost. List of strings optional [] prost_plugin Additional plugins to add to Prost. Label required prost_plugin_flag Prost plugin flag format. (e.g. --plugin=protoc-gen-prost=%s) String optional \"--plugin=protoc-gen-prost=%s\" prost_runtime The Prost runtime crates to use. Label required prost_types The Prost types crates to use. Label required proto_compiler The protoc compiler to use. Note that this attribute is deprecated - prefer to use --incompatible_enable_proto_toolchain_resolution. Label optional None tonic_opts Additional options to add to Tonic. List of strings optional [] tonic_plugin Additional plugins to add to Tonic. Label optional None tonic_plugin_flag Tonic plugin flag format. (e.g. --plugin=protoc-gen-tonic=%s)) String optional \"--plugin=protoc-gen-tonic=%s\" tonic_runtime The Tonic runtime crates to use. Label optional None","breadcrumbs":"Extensions » prost » rust_prost_toolchain","id":"155","title":"rust_prost_toolchain"},"156":{"body":"rust_prost_transform(name, deps, srcs, prost_opts, tonic_opts) A rule for transforming the outputs of ProstGenProto actions. This rule is used by adding it to the data attribute of proto_library targets. E.g. load(\"@rules_proto//proto:defs.bzl\", \"proto_library\")\nload(\"@rules_rust_prost//:defs.bzl\", \"rust_prost_library\", \"rust_prost_transform\") rust_prost_transform( name = \"a_transform\", srcs = [ \"a_src.rs\", ],\n) proto_library( name = \"a_proto\", srcs = [ \"a.proto\", ], data = [ \":transform\", ],\n) rust_prost_library( name = \"a_rs_proto\", proto = \":a_proto\",\n) The rust_prost_library will spawn an action on the a_proto target which consumes the a_transform rule to provide a means of granularly modifying a proto library for ProstGenProto actions with minimal impact to other consumers. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Additional dependencies to add to the compiled crate. List of labels optional [] srcs Additional source files to include in generated Prost source code. List of labels optional [] prost_opts Additional options to add to Prost. List of strings optional [] tonic_opts Additional options to add to Tonic. List of strings optional []","breadcrumbs":"Extensions » prost » rust_prost_transform","id":"156","title":"rust_prost_transform"},"157":{"body":"These build rules are used for building protobufs / gRPC in Rust with Bazel using rust-protobuf .","breadcrumbs":"Extensions » protobuf » rules_rust_protobuf","id":"157","title":"rules_rust_protobuf"},"158":{"body":"To use the Rust proto rules, add the following to your WORKSPACE file to add the external repositories for the Rust proto toolchain (in addition to the rust rules setup ): load(\"@rules_rust//proto/protobuf:repositories.bzl\", \"rust_proto_protobuf_dependencies\", \"rust_proto_protobuf_register_toolchains\") rust_proto_protobuf_dependencies() rust_proto_protobuf_register_toolchains() load(\"@rules_rust//proto/protobuf:transitive_repositories.bzl\", \"rust_proto_protobuf_transitive_repositories\") rust_proto_protobuf_transitive_repositories() This will load the required dependencies for the rust-protobuf rules. It will also register a default toolchain for the rust_proto_library and rust_grpc_library rules. To customize the rust_proto_library and rust_grpc_library toolchain, please see the section Customizing rust-protobuf Dependencies . For additional information about Bazel toolchains, see here . Customizing rust-protobuf Dependencies These rules depend on the protobuf and the grpc crates in addition to the protobuf compiler . To obtain these crates, rust_proto_repositories imports the given crates using BUILD files generated with crate_universe . If you want to either change the protobuf and gRPC rust compilers, or to simply use crate_universe in a more complex scenario (with more dependencies), you must redefine those dependencies. To do this, once you've imported the needed dependencies (see our @rules_rust//proto/protobuf/3rdparty/BUILD.bazel file to see the default dependencies), you need to create your own toolchain. To do so you can create a BUILD file with your toolchain definition, for example: load(\"@rules_rust//proto:toolchain.bzl\", \"rust_proto_toolchain\") rust_proto_toolchain( name = \"proto-toolchain-impl\", # Path to the protobuf compiler. protoc = \"@com_google_protobuf//:protoc\", # Protobuf compiler plugin to generate rust gRPC stubs. grpc_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust_grpc\", # Protobuf compiler plugin to generate rust protobuf stubs. proto_plugin = \"//3rdparty/crates:cargo_bin_protoc_gen_rust\",\n) toolchain( name = \"proto-toolchain\", toolchain = \":proto-toolchain-impl\", toolchain_type = \"@rules_rust//proto/protobuf:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:proto-toolchain\") Finally, you might want to set the rust_deps attribute in rust_proto_library and rust_grpc_library to change the compile-time dependencies: rust_proto_library( ... rust_deps = [\"//3rdparty/crates:protobuf\"], ...\n) rust_grpc_library( ... rust_deps = [ \"//3rdparty/crates:protobuf\", \"//3rdparty/crates:grpc\", \"//3rdparty/crates:tls_api\", \"//3rdparty/crates:tls_api_stub\", ], ...\n) Note : Ideally, we would inject those dependencies from the toolchain, but due to bazelbuild/bazel#6889 all dependencies added via the toolchain ends-up being in the wrong configuration.","breadcrumbs":"Extensions » protobuf » Setup","id":"158","title":"Setup"},"159":{"body":"rust_grpc_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys suitable for gRPC. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_grpc_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_grpc_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_service\", srcs = [\"my_service.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding gRPC stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_grpc_library","id":"159","title":"rust_grpc_library"},"16":{"body":"rust_binary(name, deps, srcs, data, aliases, alwayslink, binary_name, compile_data, crate_features, crate_name, crate_root, crate_type, edition, env, experimental_use_cc_common_link, linker_script, malloc, out_binary, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust binary crate. Example: Suppose you have the following directory structure for a Rust project with a library crate, hello_lib, and a binary crate, hello_world that uses the hello_lib library: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_world/ BUILD src/ main.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) hello_world/src/main.rs: extern crate hello_lib; fn main() { let hello = hello_lib::Greeter::new(\"Hello\"); hello.greet(\"world\");\n} hello_world/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_binary\") rust_binary( name = \"hello_world\", srcs = [\"src/main.rs\"], deps = [\"//hello_lib\"],\n) Build and run hello_world: $ bazel run //hello_world\nINFO: Found 1 target...\nTarget //examples/rust/hello_world:hello_world up-to-date:\nbazel-bin/examples/rust/hello_world/hello_world\nINFO: Elapsed time: 1.308s, Critical Path: 1.22s INFO: Running command line: bazel-bin/examples/rust/hello_world/hello_world\nHello world On Windows, a PDB file containing debugging information is available under the key pdb_file in OutputGroupInfo. Similarly on macOS, a dSYM folder is available under the key dsym_folder in OutputGroupInfo. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False binary_name Override the resulting binary file name. By default, the binary file will be named using the name attribute on this rule, however sometimes that is not deseriable. String optional \"\" compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None crate_type Crate type that will be passed to rustc to be used for building this crate.This option is a temporary workaround and should be used only when building for WebAssembly targets (//rust/platform:wasi and //rust/platform:wasm). String optional \"bin\" edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the target is executed by bazel run. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution.Execpath returns absolute path, and in order to be able to construct the absolute path we need to wrap the test binary in a launcher. Using a launcher comes with complications, such as more complicated debugger attachment. Dictionary: String -> String optional {} experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 linker_script Link script to forward into linker via rustc options. Label optional None malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" out_binary Force a target, regardless of it's crate_type, to always mark the file as executable. This attribute is only used to support wasm targets but is expected to be removed following a resolution to https://github.com/bazelbuild/rules_rust/issues/771. Boolean optional False platform Optional platform to transition the binary to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional -1 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_binary","id":"16","title":"rust_binary"},"160":{"body":"rust_proto_library(name, deps, crate_name, rust_deps, rustc_flags) Builds a Rust library crate from a set of proto_librarys. Example: load(\"@rules_rust_protobuf//:defs.bzl\", \"rust_proto_library\") proto_library( name = \"my_proto\", srcs = [\"my.proto\"]\n) rust_proto_library( name = \"rust\", deps = [\":my_proto\"],\n) rust_binary( name = \"my_proto_binary\", srcs = [\"my_proto_binary.rs\"], deps = [\":rust\"],\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding stubs. List of labels required crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" rust_deps The crates the generated library depends on. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional []","breadcrumbs":"Extensions » protobuf » rust_proto_library","id":"160","title":"rust_proto_library"},"161":{"body":"Bazel rules for generating wasm modules for Javascript using wasm-bindgen .","breadcrumbs":"Extensions » wasm_bindgen » rules_rust_wasm_bindgen","id":"161","title":"rules_rust_wasm_bindgen"},"162":{"body":"rust_wasm_bindgen rust_wasm_bindgen_toolchain","breadcrumbs":"Extensions » wasm_bindgen » Rules","id":"162","title":"Rules"},"163":{"body":"To begin using the wasm-bindgen rules, users can load the necessary dependencies in their workspace by adding the following to their WORKSPACE.bazel file. load(\"@rules_rust_wasm_bindgen//:repositories.bzl\", \"rust_wasm_bindgen_dependencies\", \"rust_wasm_bindgen_register_toolchains\") rust_wasm_bindgen_dependencies() rust_wasm_bindgen_register_toolchains() This should enable users to start using the rust_wasm_bindgen rule. However, it's common to want to control the version of wasm-bindgen in the workspace instead of relying on the one provided by rules_rust. In this case, users should avoid calling rust_wasm_bindgen_register_toolchains and instead use the rust_wasm_bindgen_toolchain rule to define their own toolchains to register in the workspace.","breadcrumbs":"Extensions » wasm_bindgen » Setup","id":"163","title":"Setup"},"164":{"body":"While it's recommended for users to mantain their own , in the @rules_rust_wasm_bindgen package there exists interface sub-packages for various Javascript Bazel rules. E.g. aspect_rules_js. The rules defined there are a more convenient way to use rust_wasm_bindgen with the associated javascript rules due to the inclusion of additional providers. Each directory contains a defs.bzl file that defines the different variants of rust_wasm_bindgen. (e.g. js_rust_wasm_bindgen for the rules_js submodule).","breadcrumbs":"Extensions » wasm_bindgen » Interfacing with Javascript rules","id":"164","title":"Interfacing with Javascript rules"},"165":{"body":"rust_wasm_bindgen(name, bindgen_flags, out_name, target, target_arch, wasm_file) Generates javascript and typescript bindings for a webassembly module using wasm-bindgen . An example of this rule in use can be seen at @rules_rust//examples/wasm ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen_flags Flags to pass directly to the wasm-bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details. List of strings optional [] out_name Set a custom output filename (Without extension. Defaults to target name). String optional \"\" target The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details. String optional \"bundler\" target_arch The target architecture to use for the wasm-bindgen command line option. String optional \"wasm32\" wasm_file The .wasm file or crate to generate bindings for. Label required","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen","id":"165","title":"rust_wasm_bindgen"},"166":{"body":"rust_wasm_bindgen_toolchain(name, bindgen) The tools required for the rust_wasm_bindgen rule. In cases where users want to control or change the version of wasm-bindgen used by rust_wasm_bindgen , a unique toolchain can be created as in the example below: load(\"@rules_rust_bindgen//:defs.bzl\", \"rust_bindgen_toolchain\") rust_bindgen_toolchain( bindgen = \"//3rdparty/crates:wasm_bindgen_cli__bin\",\n) toolchain( name = \"wasm_bindgen_toolchain\", toolchain = \"wasm_bindgen_toolchain_impl\", toolchain_type = \"@rules_rust_wasm_bindgen//:toolchain_type\",\n) Now that you have your own toolchain, you need to register it by inserting the following statement in your WORKSPACE file: register_toolchains(\"//my/toolchains:wasm_bindgen_toolchain\") For additional information, see the Bazel toolchains documentation . ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required bindgen The label of a wasm-bindgen-cli executable. Label optional None","breadcrumbs":"Extensions » wasm_bindgen » rust_wasm_bindgen_toolchain","id":"166","title":"rust_wasm_bindgen_toolchain"},"167":{"body":"RustWasmBindgenInfo(js, root, snippets, ts, wasm) Info about wasm-bindgen outputs. FIELDS Name Description js Depset[File]: The Javascript files produced by wasm-bindgen. root str: The path to the root of the wasm-bindgen --out-dir directory. snippets File: The snippets directory produced by wasm-bindgen. ts Depset[File]: The Typescript files produced by wasm-bindgen. wasm File: The .wasm file generated by wasm-bindgen.","breadcrumbs":"Extensions » wasm_bindgen » RustWasmBindgenInfo","id":"167","title":"RustWasmBindgenInfo"},"17":{"body":"rust_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, disable_pipelining, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust library crate. Example: Suppose you have the following directory structure for a simple Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ greeter.rs lib.rs hello_lib/src/greeter.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!(\"{} {}\", &self.greeting, thing); }\n} hello_lib/src/lib.rs: pub mod greeter; hello_lib/BUILD: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\") rust_library( name = \"hello_lib\", srcs = [ \"src/greeter.rs\", \"src/lib.rs\", ],\n) Build the library: $ bazel build //hello_lib\nINFO: Found 1 target...\nTarget //examples/rust/hello_lib:hello_lib up-to-date:\nbazel-bin/examples/rust/hello_lib/libhello_lib.rlib\nINFO: Elapsed time: 1.245s, Critical Path: 1.01s ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None disable_pipelining Disables pipelining for this rule if it is globally enabled. This will cause this rule to not produce a .rmeta file and all the dependent crates will instead use the .rlib file. Boolean optional False edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_library","id":"17","title":"rust_library"},"18":{"body":"rust_library_group(name, deps) Functions as an alias for a set of dependencies. Specifically, the following are equivalent: rust_library_group( name = \"crate_group\", deps = [ \":crate1\", \":crate2\", ],\n) rust_library( name = \"foobar\", deps = [\":crate_group\"], ...\n) and rust_library( name = \"foobar\", deps = [ \":crate1\", \":crate2\", ], ...\n) ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps Other dependencies to forward through this crate group. List of labels optional []","breadcrumbs":"Rules » rust » rust_library_group","id":"18","title":"rust_library_group"},"19":{"body":"rust_proc_macro(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust proc-macro crate. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_proc_macro","id":"19","title":"rust_proc_macro"},"2":{"body":"Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into. To use rules_rust in a project using bzlmod, add the following to your MODULE.bazel file: bazel_dep(name = \"rules_rust\", version = \"0.48.0\") Don't forget to substitute in your desired release's version number.","breadcrumbs":"Introduction » Bzlmod","id":"2","title":"Bzlmod"},"20":{"body":"rust_shared_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust shared library. This shared library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce a shared library that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the shared library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_shared_library","id":"20","title":"rust_shared_library"},"21":{"body":"rust_static_library(name, deps, srcs, data, aliases, alwayslink, compile_data, crate_features, crate_name, crate_root, edition, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, version) Builds a Rust static library. This static library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce an archive that Python program links against). This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc. When building the whole binary in Bazel, use rust_library instead. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" platform Optional platform to transition the static library to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » rust_static_library","id":"21","title":"rust_static_library"},"22":{"body":"rust_test(name, deps, srcs, data, aliases, alwayslink, compile_data, crate, crate_features, crate_name, crate_root, edition, env, env_inherit, experimental_use_cc_common_link, malloc, platform, proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, stamp, use_libtest_harness, version) Builds a Rust test crate. Examples: Suppose you have the following directory structure for a Rust library crate with unit test code in the library sources: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs hello_lib/src/lib.rs: pub struct Greeter { greeting: String,\n} impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) -> String { format!(\"{} {}\", &self.greeting, thing) }\n} #[cfg(test)]\nmod test { use super::Greeter; #[test] fn test_greeting() { let hello = Greeter::new(\"Hi\"); assert_eq!(\"Hi Rust\", hello.greet(\"Rust\")); }\n} To build and run the tests, simply add a rust_test rule with no srcs and only depends on the hello_lib rust_library target via the crate attribute: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"hello_lib_test\", crate = \":hello_lib\", # You may add other deps that are specific to the test configuration deps = [\"//some/dev/dep\"],\n) Run the test with bazel test //hello_lib:hello_lib_test.","breadcrumbs":"Rules » rust » rust_test","id":"22","title":"rust_test"},"23":{"body":"Integration tests that live in the tests directory , they are essentially built as separate crates. Suppose you have the following directory structure where greeting.rs is an integration test for the hello_lib library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs tests/ greeting.rs hello_lib/tests/greeting.rs: extern crate hello_lib; use hello_lib; #[test]\nfn test_greeting() { let hello = greeter::Greeter::new(\"Hello\"); assert_eq!(\"Hello world\", hello.greeting(\"world\"));\n} To build the greeting.rs integration test, simply add a rust_test target with greeting.rs in srcs and a dependency on the hello_lib target: hello_lib/BUILD: load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_test\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_test( name = \"greeting_test\", srcs = [\"tests/greeting.rs\"], deps = [\":hello_lib\"],\n) Run the test with bazel test //hello_lib:greeting_test. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required deps List of other libraries to be linked to this library target.These can be either other rust_library targets or cc_library targets if linking a native library. List of labels optional [] srcs List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. List of labels optional [] data List of files used by this rule at compile time and runtime.If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. List of labels optional [] aliases Remap crates to a new name or moniker for linkage to this targetThese are other rust_library targets and will be presented as the new name given. Dictionary: Label -> String optional {} alwayslink If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary.This attribute is used by the C++ Starlark API when passing CcInfo providers. Boolean optional False compile_data List of files used by this rule at compile time.This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. List of labels optional [] crate Target inline tests declared in the given crateThese tests are typically those that would be held out under #[cfg(test)] declarations. Label optional None crate_features List of features to enable for this crate.Features are defined in the code using the #[cfg(feature = \"foo\")] configuration option. The features listed here will be passed to rustc with --cfg feature=\"${feature_name}\" flags. List of strings optional [] crate_name Crate name to use for this target.This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. String optional \"\" crate_root The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file. Label optional None edition The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. String optional \"\" env Specifies additional environment variables to set when the test is executed by bazel test. Values are subject to $(rootpath), $(execpath), location, and \"Make variable\" substitution. Dictionary: String -> String optional {} env_inherit Specifies additional environment variables to inherit from the external environment when the test is executed by bazel test. List of strings optional [] experimental_use_cc_common_link Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. Integer optional -1 malloc Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @bazel_tools//tools/cpp:malloc\", which is an empty library and the resulting binary will use libc's malloc. This label must refer to a cc_library rule. Label optional \"@bazel_tools//tools/cpp:malloc\" platform Optional platform to transition the test to. Label optional None proc_macro_deps List of rust_proc_macro targets used to help build this library target. List of labels optional [] rustc_env Dictionary of additional \"key\": \"value\" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. Dictionary: String -> String optional {} rustc_env_files Files containing additional environment variables to set for rustc.These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged.Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. List of labels optional [] rustc_flags List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). List of strings optional [] stamp Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change.For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. Integer optional 0 use_libtest_harness Whether to use libtest. For targets using this flag, individual tests can be run by using the --test_arg flag. E.g. bazel test //src:rust_test --test_arg=foo::test::test_fn. Boolean optional True version A version to inject in the cargo environment variable. String optional \"0.0.0\"","breadcrumbs":"Rules » rust » Example: test directory","id":"23","title":"Example: test directory"},"24":{"body":"rust_test_suite(name, srcs, shared_srcs, kwargs) A rule for creating a test suite for a set of rust_test targets. This rule can be used for setting up typical rust integration tests . Given the following directory structure: [crate]/ BUILD.bazel src/ lib.rs main.rs tests/ integrated_test_a.rs integrated_test_b.rs integrated_test_c.rs patterns/ fibonacci_test.rs helpers/ mod.rs The rule can be used to generate rust_test targets for each source file under tests and a test_suite which encapsulates all tests. load(\"//rust:defs.bzl\", \"rust_binary\", \"rust_library\", \"rust_test_suite\") rust_library( name = \"math_lib\", srcs = [\"src/lib.rs\"],\n) rust_binary( name = \"math_bin\", srcs = [\"src/main.rs\"],\n) rust_test_suite( name = \"integrated_tests_suite\", srcs = glob([\"tests/**\"]), shared_srcs=glob([\"tests/helpers/**\"]), deps = [\":math_lib\"],\n) PARAMETERS Name Description Default Value name The name of the test_suite. none srcs All test sources, typically glob([\"tests/**/*.rs\"]). none shared_srcs Optional argument for sources shared among tests, typically helper functions. [] kwargs Additional keyword arguments for the underyling rust_test targets. The tags argument is also passed to the generated test_suite target. none","breadcrumbs":"Rules » rust » rust_test_suite","id":"24","title":"rust_test_suite"},"25":{"body":"rust_doc rust_doc_test","breadcrumbs":"Rules » rustdoc » Rust Doc","id":"25","title":"Rust Doc"},"26":{"body":"rust_doc(name, crate, html_after_content, html_before_content, html_in_header, markdown_css, rustc_flags, rustdoc_flags) Generates code documentation. Example: Suppose you have the following directory structure for a Rust library crate: [workspace]/ WORKSPACE hello_lib/ BUILD src/ lib.rs To build rustdoc documentation for the hello_lib crate, define a rust_doc rule that depends on the the hello_lib rust_library target: package(default_visibility = [\"//visibility:public\"]) load(\"@rules_rust//rust:defs.bzl\", \"rust_library\", \"rust_doc\") rust_library( name = \"hello_lib\", srcs = [\"src/lib.rs\"],\n) rust_doc( name = \"hello_lib_doc\", crate = \":hello_lib\",\n) Running bazel build //hello_lib:hello_lib_doc will build a zip file containing the documentation for the hello_lib library crate generated by rustdoc. ATTRIBUTES Name Description Type Mandatory Default name A unique name for this target. Name required crate The label of the target to generate code documentation for.rust_doc can generate HTML code documentation for the source files of rust_library or rust_binary targets. Label required html_after_content File to add in , after content. Label optional None html_before_content File to add in , before content. Label optional None html_in_header File to add to . Label optional None markdown_css CSS files to include via