' that takes a single label parameter 'actual'. See '@crate_index//:alias_rules.bzl' for an example. | `"alias"` |
+| crates_repository::packages. | `"2"` |
+|
+crates_repository(name , annotations , cargo_config , cargo_lockfile , generate_binaries ,
+ generate_build_scripts , generate_target_compatible_with , generator ,
+ generator_sha256s , generator_urls , isolated , lockfile , manifests , packages , quiet ,
+ render_config , 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](#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](#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:
+
+```text
+[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:
+
+```python
+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",
+)
+```
+
+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.
+
+### Repinning / Updating Dependencies
+
+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:
+
+```shell
+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](https://doc.rust-lang.org/cargo/commands/cargo-update.html) 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:
+
+```shell
+CARGO_BAZEL_REPIN=1 CARGO_BAZEL_REPIN_ONLY=crate_index bazel sync --only=crate_index
+```
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| Name | required | |
+| Dictionary: String -> List of strings | optional | `{}` |
+| Label | optional | `None` |
+| Label | required | |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | `{}` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | |
+|
+crate = use_extension("@rules_rust//crate_universe:docs_bzlmod.bzl", "crate")
+crate.from_cargo(name , cargo_config , cargo_lockfile , generate_binaries , generate_build_scripts ,
+ manifests , supported_platform_triples )
+crate.annotation(deps , data , additive_build_file , additive_build_file_content , alias_rule ,
+ build_script_data , 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_tools , compile_data , compile_data_glob , crate ,
+ crate_features , data_glob , disable_pipelining , extra_aliased_targets ,
+ gen_all_binaries , gen_binaries , gen_build_script , override_target_bin ,
+ override_target_build_script , override_target_lib , override_target_proc_macro ,
+ patch_args , patch_tool , patches , proc_macro_deps , repositories , rustc_env ,
+ rustc_env_files , rustc_flags , shallow_since , version )
+crate.from_specs(name , cargo_config , generate_binaries , generate_build_scripts ,
+ supported_platform_triples )
+crate.spec(artifact , branch , default_features , features , git , lib , package , rev , tag , version )
+
+
+
+**TAG CLASSES**
+
+Name | optional | `"crates"` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| Name | optional | `"crates"` |
+| Label | optional | `None` |
+|
-rust_binary(name , aliases , compile_data , crate_features , crate_name , crate_root , crate_type , data ,
- deps , edition , env , experimental_use_cc_common_link , linker_script , malloc , out_binary ,
- platform , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags , srcs , stamp , version )
+rust_binary(name , deps , srcs , data , aliases , 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.
@@ -124,7 +125,7 @@ pub struct Greeter {
}
impl Greeter {
- pub fn new(greeting: &str) -> Greeter {
+ pub fn new(greeting: &str) -> Greeter {
Greeter { greeting: greeting.to_string(), }
}
@@ -189,28 +190,28 @@ is available under the key `dsym_folder` in `OutputGroupInfo`.
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| rustc to be used for building this crate."bin" |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| $(rootpath), $(execpath), location, and ["Make variable"](https://docs.bazel.build/versions/master/be/make-variables.html) substitution.Dictionary: String -> String | optional | {} |
-| -1 |
-| Label | optional | None |
-| malloc.@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 |
-| 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 |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | -1 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{}` |
+| Label | optional | `None` |
+| Label | optional | `"@bazel_tools//tools/cpp:malloc"` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+|
-rust_library(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
+rust_library(name , deps , srcs , data , aliases , compile_data , crate_features , crate_name , crate_root ,
disable_pipelining , edition , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags ,
- srcs , stamp , version )
+ stamp , version )
Builds a Rust library crate.
@@ -246,7 +247,7 @@ pub struct Greeter {
}
impl Greeter {
- pub fn new(greeting: &str) -> Greeter {
+ pub fn new(greeting: &str) -> Greeter {
Greeter { greeting: greeting.to_string(), }
}
@@ -286,29 +287,28 @@ bazel-bin/examples/rust/hello_lib/libhello_lib.rlib
INFO: Elapsed time: 1.245s, Critical Path: 1.01s
```
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| .rmeta file and all the dependent crates will instead use the .rlib file. | Boolean | optional | False |
-| "" |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Name | required | |
-| List of labels | optional | [] |
+| List of labels | optional | `[]` |
-rust_proc_macro(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
- edition , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags , srcs , stamp ,
+rust_proc_macro(name , deps , srcs , data , aliases , 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 | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+|
-rust_shared_library(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
- edition , experimental_use_cc_common_link , malloc , platform , proc_macro_deps ,
- rustc_env , rustc_env_files , rustc_flags , srcs , stamp , version )
+rust_shared_library(name , deps , srcs , data , aliases , 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.
@@ -418,31 +416,30 @@ 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 | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| -1 |
-| malloc.@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 |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Label | optional | `"@bazel_tools//tools/cpp:malloc"` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+|
-rust_static_library(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
- edition , platform , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags , srcs ,
- stamp , version )
+rust_static_library(name , deps , srcs , data , aliases , 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.
@@ -465,29 +462,28 @@ 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 | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+|
-rust_test(name , aliases , compile_data , crate , crate_features , crate_name , crate_root , data , deps ,
- edition , env , experimental_use_cc_common_link , malloc , platform , proc_macro_deps , rustc_env ,
- rustc_env_files , rustc_flags , srcs , stamp , use_libtest_harness , version )
+rust_test(name , deps , srcs , data , aliases , compile_data , crate , crate_features , crate_name ,
+ crate_root , edition , env , 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.
@@ -522,11 +519,11 @@ pub struct Greeter {
}
impl Greeter {
- pub fn new(greeting: &str) -> Greeter {
+ pub fn new(greeting: &str) -> Greeter {
Greeter { greeting: greeting.to_string(), }
}
- pub fn greet(&self, thing: &str) -> String {
+ pub fn greet(&self, thing: &str) -> String {
format!("{} {}", &self.greeting, thing)
}
}
@@ -625,27 +622,27 @@ Run the test with `bazel test //hello_lib:greeting_test`.
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(test)] declarations. | Label | optional | None |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| $(rootpath), $(execpath), location, and ["Make variable"](https://docs.bazel.build/versions/master/be/make-variables.html) substitution. | Dictionary: String -> String | optional | {} |
-| -1 |
-| malloc.@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 |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| libtest. For targets using this flag, individual tests can be run by using the [--test_arg](https://docs.bazel.build/versions/4.0.0/command-line-reference.html#flag--test_arg) flag. E.g. bazel test //src:rust_test --test_arg=foo::test::test_fn. | Boolean | optional | True |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{}` |
+| Label | optional | `"@bazel_tools//tools/cpp:malloc"` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| test_suite. | none |
-| glob(["tests/**/*.rs"]). | none |
-| tags argument is also passed to the generated test_suite target. | none |
+| Name | required | |
-
-cargo_bootstrap_repository(name , binary , build_mode , cargo_lockfile , cargo_toml , env , env_label ,
- repo_mapping , rust_toolchain_cargo_template , rust_toolchain_rustc_template ,
- srcs , timeout , version )
-
-
-A rule for bootstrapping a Rust binary using [Cargo](https://doc.rust-lang.org/cargo/)
-
-**ATTRIBUTES**
-
-
-| Name | Description | Type | Mandatory | Default |
-| :------------- | :------------- | :------------- | :------------- | :------------- |
-| Name | required | |
-| --bin parameter for Cargo). If left empty, the repository name will be used. | String | optional | "" |
-| "release" |
-| Label | required | |
-| Cargo.toml file) | Label | required | |
-| * applies to all platforms. | Dictionary: String -> String | optional | {} |
-| env in that all variables passed here must be fully qualified labels of files. See [cargo_env](#cargo_env) for usage details. Additionally, the platform triple * applies to all platforms. | Dictionary: String -> String | optional | {} |
-| "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | |
-| cargo binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {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}" |
-| rustc binary. {version} (eg. '1.53.0'), {triple} (eg. 'x86_64-unknown-linux-gnu'), {arch} (eg. 'aarch64'), {vendor} (eg. 'unknown'), {system} (eg. 'darwin'), {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}" |
-| List of labels | optional | [] |
-| 600 |
-| 1.56.0, or nightly/2021-09-08 | String | optional | "1.79.0" |
-
-
-cargo_dep_env(name , out_dir , src )
+cargo_dep_env(name , src , out_dir )
A rule for generating variables for dependent `cargo_build_script`s without a build script. This is useful for using Bazel rules instead of a build script, while also generating configuration information for build scripts which depend on this crate.
@@ -128,8 +96,8 @@ A rule for generating variables for dependent `cargo_build_script`s without a bu
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| cargo_build_script which prints puts files into $OUT_DIR, but without requiring a build script. | Label | optional | None |
-| cargo_build_script which prints cargo:VAR=VALUE lines, but without requiring a build script.NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\). | Label | required | |
+| Label | required | |
+| Label | optional | `None` |
Name | required | |
-| rust_analyzer_proc_macro_srv binary. | Label | optional | None |
-| rustc binary. | Label | required | |
+| Label | optional | `None` |
+| Label | required | |
| Label | required | |
@@ -231,9 +199,10 @@ A toolchain for [rust-analyzer](https://rust-analyzer.github.io/).
## rust_binary
-rust_binary(name , aliases , compile_data , crate_features , crate_name , crate_root , crate_type , data ,
- deps , edition , env , experimental_use_cc_common_link , linker_script , malloc , out_binary ,
- platform , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags , srcs , stamp , version )
+rust_binary(name , deps , srcs , data , aliases , 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.
@@ -264,7 +233,7 @@ pub struct Greeter {
}
impl Greeter {
- pub fn new(greeting: &str) -> Greeter {
+ pub fn new(greeting: &str) -> Greeter {
Greeter { greeting: greeting.to_string(), }
}
@@ -329,28 +298,28 @@ is available under the key `dsym_folder` in `OutputGroupInfo`.
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| rustc to be used for building this crate."bin" |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| $(rootpath), $(execpath), location, and ["Make variable"](https://docs.bazel.build/versions/master/be/make-variables.html) substitution.Dictionary: String -> String | optional | {} |
-| -1 |
-| Label | optional | None |
-| malloc.@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 |
-| 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 |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | -1 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{}` |
+| Label | optional | `None` |
+| Label | optional | `"@bazel_tools//tools/cpp:malloc"` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Name | required | |
-| [] |
-| .h file. This is used to find the transitive includes. | Label | required | |
-| [] |
-| header | The .h file to generate bindings for. | Label | required | |
+| Label | required | |
+| Label | required | |
name , Name | required | |
-| bindgen executable. | Label | optional | None |
-| clang executable. | Label | optional | None |
-| rust_bindgen targets will always format generated sources with rustfmt. | Boolean | optional | True |
-| Label | optional | None |
-| Label | optional | None |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
Name | required | |
-| List of labels | optional | [] |
+| List of labels | optional | `[]` |
Name | required | |
-| rust_doc can generate HTML code documentation for the source files of rust_library or rust_binary targets. | Label | required | |
-| <body>, after content. | Label | optional | None |
-| <body>, before content. | Label | optional | None |
-| html_in_header | File to add to <head>. | Label | optional | None |
-| <link> in a rendered Markdown file. | List of labels | optional | [] |
-| rustdoc_flags instead | List of strings | optional | [] |
-| rustdoc.$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 | [] |
+| Label | required | |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| html_in_header | File to add to ``. | Label | optional | `None` |
+| List of labels | optional | `[]` |
+|
-rust_doc_test(name , crate , deps )
+rust_doc_test(name , deps , crate )
Runs Rust documentation tests.
@@ -584,15 +550,14 @@ rust_doc_test(
Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation tests for the `hello_lib` library crate.
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_doc_test can generate HTML code documentation for the source files of rust_library or rust_binary targets. | Label | required | |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
+| List of labels | optional | `[]` |
+| Label | required | |
-rust_grpc_library(name , crate_name , deps , rust_deps , rustc_flags )
+rust_grpc_library(name , deps , crate_name , rust_deps , rustc_flags )
Builds a Rust library crate from a set of `proto_library`s suitable for gRPC.
@@ -627,17 +592,16 @@ rust_binary(
)
```
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| "" |
| List of labels | required | |
-| List of labels | optional | [] |
-| rustc.$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 | [] |
+| List of labels | optional | `[]` |
+|
-rust_library(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
+rust_library(name , deps , srcs , data , aliases , compile_data , crate_features , crate_name , crate_root ,
disable_pipelining , edition , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags ,
- srcs , stamp , version )
+ stamp , version )
Builds a Rust library crate.
@@ -673,7 +637,7 @@ pub struct Greeter {
}
impl Greeter {
- pub fn new(greeting: &str) -> Greeter {
+ pub fn new(greeting: &str) -> Greeter {
Greeter { greeting: greeting.to_string(), }
}
@@ -713,29 +677,28 @@ bazel-bin/examples/rust/hello_lib/libhello_lib.rlib
INFO: Elapsed time: 1.245s, Critical Path: 1.01s
```
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| .rmeta file and all the dependent crates will instead use the .rlib file. | Boolean | optional | False |
-| "" |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Name | required | |
-| List of labels | optional | [] |
+| List of labels | optional | `[]` |
-rust_proc_macro(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
- edition , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags , srcs , stamp ,
+rust_proc_macro(name , deps , srcs , data , aliases , 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 | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Name | required | |
-| [] |
+| Label | required | |
-| --plugin=protoc-gen-prost=%s) | String | optional | "--plugin=protoc-gen-prost=%s" |
+| Label | required | |
| Label | required | |
| Label | required | |
-| [] |
-| Label | optional | None |
-| --plugin=protoc-gen-tonic=%s)) | String | optional | "--plugin=protoc-gen-tonic=%s" |
-| Label | optional | None |
+| Label | optional | `None` |
+| Label | optional | `None` |
-rust_proto_library(name , crate_name , deps , rust_deps , rustc_flags )
+rust_proto_library(name , deps , crate_name , rust_deps , rustc_flags )
Builds a Rust library crate from a set of `proto_library`s.
@@ -886,17 +847,16 @@ rust_binary(
)
```
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| "" |
| List of labels | required | |
-| List of labels | optional | [] |
-| rustc.$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 | [] |
+| List of labels | optional | `[]` |
+|
-rust_shared_library(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
- edition , experimental_use_cc_common_link , malloc , platform , proc_macro_deps ,
- rustc_env , rustc_env_files , rustc_flags , srcs , stamp , version )
+rust_shared_library(name , deps , srcs , data , aliases , 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.
@@ -919,31 +879,30 @@ 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 | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| -1 |
-| malloc.@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 |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Label | optional | `"@bazel_tools//tools/cpp:malloc"` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+|
-rust_static_library(name , aliases , compile_data , crate_features , crate_name , crate_root , data , deps ,
- edition , platform , proc_macro_deps , rustc_env , rustc_env_files , rustc_flags , srcs ,
- stamp , version )
+rust_static_library(name , deps , srcs , data , aliases , 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.
@@ -966,29 +925,28 @@ 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 | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+|
-rust_test(name , aliases , compile_data , crate , crate_features , crate_name , crate_root , data , deps ,
- edition , env , experimental_use_cc_common_link , malloc , platform , proc_macro_deps , rustc_env ,
- rustc_env_files , rustc_flags , srcs , stamp , use_libtest_harness , version )
+rust_test(name , deps , srcs , data , aliases , compile_data , crate , crate_features , crate_name ,
+ crate_root , edition , env , 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.
@@ -1042,11 +1001,11 @@ pub struct Greeter {
}
impl Greeter {
- pub fn new(greeting: &str) -> Greeter {
+ pub fn new(greeting: &str) -> Greeter {
Greeter { greeting: greeting.to_string(), }
}
- pub fn greet(&self, thing: &str) -> String {
+ pub fn greet(&self, thing: &str) -> String {
format!("{} {}", &self.greeting, thing)
}
}
@@ -1145,27 +1104,27 @@ Run the test with `bazel test //hello_lib:greeting_test`.
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
-| include_str!](https://doc.rust-lang.org/std/macro.include_str!.html) macro. | List of labels | optional | [] |
-| #[cfg(test)] declarations. | Label | optional | None |
-| #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
-| "" |
-| rustc to be used for building this crate.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 |
-| compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
-| "" |
-| $(rootpath), $(execpath), location, and ["Make variable"](https://docs.bazel.build/versions/master/be/make-variables.html) substitution. | Dictionary: String -> String | optional | {} |
-| -1 |
-| malloc.@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 |
-| Label | optional | None |
-| rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
-| "key": "value" environment variables to set for rustc.Dictionary: String -> String | optional | {} |
-| NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).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.$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 | [] |
-| .rs source files used to build the library.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 | [] |
-| Rustc action. Possible values:stamp = 1: Always stamp the build information into the Rustc action, even in [--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) 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](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.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](https://docs.bazel.build/versions/main/be/c-cpp.html#cc_library.linkstamp) behaves. | Integer | optional | 0 |
-| libtest. For targets using this flag, individual tests can be run by using the [--test_arg](https://docs.bazel.build/versions/4.0.0/command-line-reference.html#flag--test_arg) flag. E.g. bazel test //src:rust_test --test_arg=foo::test::test_fn. | Boolean | optional | True |
-| "0.0.0" |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| List of labels | optional | `[]` |
+| Dictionary: Label -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{}` |
+| Label | optional | `"@bazel_tools//tools/cpp:malloc"` |
+| Label | optional | `None` |
+| List of labels | optional | `[]` |
+| Dictionary: String -> String | optional | `{}` |
+| List of labels | optional | `[]` |
+| Name | required | |
-| Label | optional | @rules_rust//ffi/cc/allocator_library |
+| Label | optional | `"@rules_rust//ffi/cc/allocator_library"` |
| cargo binary. Can be a direct source or a filegroup containing one item. | Label | optional | None |
-| clippy-driver binary. Can be a direct source or a filegroup containing one item. | Label | optional | None |
-| Dictionary: String -> String | optional | {"dbg": "2", "fastbuild": "0", "opt": "0"} |
-| edition attribute. | String | optional | "" |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{"dbg": "2", "fastbuild": "0", "opt": "0"}` |
+| Dictionary: String -> String | optional | {} |
+| Dictionary: String -> String | optional | `{}` |
| Label | optional | @rules_rust//rust/settings:experimental_link_std_dylib |
-| Label | optional | //rust/settings:experimental_use_cc_common_link |
-| extra_exec_rustc_flags | Extra flags to pass to rustc in exec configuration | List of strings | optional | [] |
-| extra_rustc_flags | Extra flags to pass to rustc in non-exec configuration | List of strings | optional | [] |
-| extra_rustc_flags_for_crate_types | Extra flags to pass to rustc based on crate type | Dictionary: String -> List of strings | optional | {} |
-| Label | optional | @rules_rust//ffi/cc/global_allocator_library |
-| llvm-cov binary. Can be a direct source or a filegroup containing one item. If None, rust code is not instrumented for coverage. | Label | optional | None |
-| llvm-profdata binary. Can be a direct source or a filegroup containing one item. If llvm_cov is None, this can be None as well and rust code is not instrumented for coverage. | Label | optional | None |
-| Label | optional | None |
-| Dictionary: String -> String | optional | {"dbg": "0", "fastbuild": "0", "opt": "3"} |
-| [] |
-| rustdoc binary. Can be a direct source or a filegroup containing one item. | Label | required | |
+| Label | optional | `"@rules_rust//rust/settings:experimental_link_std_dylib"` |
+| Label | optional | `"@rules_rust//rust/settings:experimental_use_cc_common_link"` |
+| extra_exec_rustc_flags | Extra flags to pass to rustc in exec configuration | List of strings | optional | `[]` |
+| extra_rustc_flags | Extra flags to pass to rustc in non-exec configuration | List of strings | optional | `[]` |
+| extra_rustc_flags_for_crate_types | Extra flags to pass to rustc based on crate type | Dictionary: String -> List of strings | optional | `{}` |
+| Label | optional | `"@rules_rust//ffi/cc/global_allocator_library"` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{"dbg": "0", "fastbuild": "0", "opt": "3"}` |
+| Label | required | |
| Label | required | |
-| rustc binary. Can be a direct source or a filegroup containing one item. | Label | required | |
-| Label | optional | None |
-| Label | optional | None |
+| Label | required | |
+| Label | optional | `None` |
+| Label | optional | `None` |
| rust_std attribute. | List of strings | required | |
-| Dictionary: String -> String | optional | {"dbg": "none", "fastbuild": "none", "opt": "debuginfo"} |
-| "" |
-| "" |
-
-
-
-rust_toolchain_repository_proxy(name , exec_compatible_with , repo_mapping , target_compatible_with ,
- target_settings , toolchain , toolchain_type )
-
-
-Generates a toolchain-bearing repository that declares the toolchains from some other rust_toolchain_repository.
-
-**ATTRIBUTES**
-
-
-| Name | Description | Type | Mandatory | Default |
-| :------------- | :------------- | :------------- | :------------- | :------------- |
-| Name | required | |
-| [] |
-| "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | |
-| [] |
-| [] |
-|
-rust_toolchain_tools_repository(name , allocator_library , auth , auth_patterns , dev_components ,
- edition , exec_triple , extra_exec_rustc_flags , extra_rustc_flags ,
- global_allocator_library , iso_date , netrc , opt_level , repo_mapping ,
- rustfmt_version , sha256s , target_triple , urls , version )
-
-
-Composes a single workspace containing the toolchain components for compiling on a given platform to a series of target platforms.
-
-A given instance of this rule should be accompanied by a toolchain_repository_proxy invocation to declare its toolchains to Bazel; the indirection allows separating toolchain selection from toolchain fetching.
-
-**ATTRIBUTES**
-
-
-| Name | Description | Type | Mandatory | Default |
-| :------------- | :------------- | :------------- | :------------- | :------------- |
-| Name | required | |
-| "@rules_rust//ffi/cc/allocator_library" |
-| Dictionary: String -> String | optional | {} |
-| [] |
-| False |
-| edition attribute. | String | optional | "" |
-| [] |
-| extra_rustc_flags | Extra flags to pass to rustc in non-exec configuration | List of strings | optional | [] |
-| "@rules_rust//ffi/cc/global_allocator_library" |
-| "" |
-| "" |
-| rust_toolchain.opt_level. | Dictionary: String -> String | optional | {} |
-| "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | |
-| "" |
-| Dictionary: String -> String | optional | {} |
-| ["https://static.rust-lang.org/dist/{}.tar.xz"] |
-| Dictionary: String -> String | optional | `{"dbg": "none", "fastbuild": "none", "opt": "debuginfo"}` |
+| Name | required | |
-| [] |
-| "bundler" |
-| .wasm file or crate to generate bindings for. | Label | required | |
+| Label | required | |
Name | required | |
-| wasm-bindgen-cli executable. | Label | optional | None |
+| Label | optional | `None` |
Name | required | |
-| rustfmt --check on. | List of labels | optional | [] |
+| List of labels | optional | `[]` |
Name | required | |
-| rustc binary. Can be a direct source or a filegroup containing one item. | Label | optional | None |
-| Label | optional | None |
-| rustfmt binary. Can be a direct source or a filegroup containing one item. | Label | required | |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | required | |
"key": "value" environment variables to set for rustc. |
+| rust_test::crate attribute) |
+| wasm-bindgen. |
-| wasm-bindgen. |
-| .wasm file generated by wasm-bindgen. |
+| .a files related to the alloc module. |
-| .a files related to the compiler_builtins module. |
-| .a files related to all modules except adler, alloc, compiler_builtins, core, and std. |
-| .a files related to the core and adler modules |
-| .a files |
-| .a files associated with the memchr module. |
-| .a files associated with panic_unwind and panic_abort. |
-| .o files from the self-contained directory. |
-| srcs attribute. |
+| .a files associated with the std module. |
-| .rlib files |
-| .a files associated with the test module. |
+| _bs. Otherwise, you can set the package name via pkg_name. | none |
+| cd to before the cargo_build_script is run. This should be a path relative to the exec root.., the cargo build script will run in the exec root. | `None` |
+| rustc. | `[]` |
+| rust_library targets and will be presented as the new name given. | `None` |
+| rust_binary rule. An exception is the compatible_with attribute, which shouldn't be forwarded to the rust_binary, as the rust_binary is only built and used in exec mode. We propagate the compatible_with attribute to the _build_scirpt_run target. | none |
+| features attribute for the rust_bindgen target. | `None` |
+| rust_library rule. | none |
+| rust_prost_library rule. | none |
+| edition attribute. | `None` |
+| versions instead. | `None` |
-| rust_toolchain targets. | `True` |
-| versions is given, then this defaults to that version, otherwise will default to the default nightly version. | `None` |
+| versions instead. | `None` |
-| ["1.65.0", "nightly/2022-11-02", "beta/2020-12-30"]. | `[]` |
+| kwargs )
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
-| rust_register_toolchains macro. | none |
+| ["1.65.0", "nightly/2022-11-02", "beta/2020-12-30"]. | `[]` |
+| edition attribute. | `None` |
+| rust_toolchain target will become a registered toolchain. | `True` |
+| test_suite. | none |
-| glob(["tests/**/*.rs"]). | none |
-| tags argument is also passed to the generated test_suite target. | none |
+| edition attribute. | `None` |
+| Name | required | |
+| Name | required | |
Name | required | |
+| Name | required | |
Name | required | |
+| Name | required | |
+
+
+
+cargo_bootstrap_repository(name , srcs , binary , build_mode , cargo_lockfile , cargo_toml , env ,
+ env_label , repo_mapping , rust_toolchain_cargo_template ,
+ rust_toolchain_rustc_template , timeout , version )
+
+
+A rule for bootstrapping a Rust binary using [Cargo](https://doc.rust-lang.org/cargo/)
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| Name | required | |
+| List of labels | optional | `[]` |
+| Label | required | |
+| Label | required | |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | |
+|
+rust_toolchain_repository_proxy(name , exec_compatible_with , repo_mapping , target_compatible_with ,
+ target_settings , toolchain , toolchain_type )
+
+
+Generates a toolchain-bearing repository that declares the toolchains from some other rust_toolchain_repository.
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| Name | required | |
+| Dictionary: String -> String | optional | |
+|
+rust_toolchain_tools_repository(name , allocator_library , auth , auth_patterns , dev_components ,
+ edition , exec_triple , extra_exec_rustc_flags , extra_rustc_flags ,
+ global_allocator_library , iso_date , netrc , opt_level , repo_mapping ,
+ rustfmt_version , sha256s , target_triple , urls , version )
+
+
+Composes a single workspace containing the toolchain components for compiling on a given platform to a series of target platforms.
+
+A given instance of this rule should be accompanied by a toolchain_repository_proxy invocation to declare its toolchains to Bazel; the indirection allows separating toolchain selection from toolchain fetching.
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| Name | required | |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | |
+| Dictionary: String -> String | optional | `{}` |
+| "key": "value" environment variables to set for rustc. |
+| rust_test::crate attribute) |
+| .a files related to the alloc module. |
-| .a files related to the compiler_builtins module. |
-| .a files related to all modules except adler, alloc, compiler_builtins, core, and std. |
-| .a files related to the core and adler modules |
-| .a files |
-| .a files associated with the memchr module. |
-| .a files associated with panic_unwind and panic_abort. |
-| .o files from the self-contained directory. |
-| srcs attribute. |
+| .a files associated with the std module. |
-| .rlib files |
-| .a files associated with the test module. |
+| Name | required | |
-| rust_analyzer_proc_macro_srv binary. | Label | optional | None |
-| rustc binary. | Label | required | |
+| Label | optional | `None` |
+| Label | required | |
| Label | required | |
@@ -137,6 +137,6 @@ Annotates rust rules with RustAnalyzerInfo later used to build a rust-project.js
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
-| Name | required | |
+| Name | required | |
diff --git a/docs/rust_bindgen.md b/docs/rust_bindgen.md
index c56ce95327..aa87c3a2b7 100644
--- a/docs/rust_bindgen.md
+++ b/docs/rust_bindgen.md
@@ -64,10 +64,10 @@ Generates a rust source file from a cc_library and a header.
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| [] |
-| .h file. This is used to find the transitive includes. | Label | required | |
-| [] |
-| header | The .h file to generate bindings for. | Label | required | |
+| Label | required | |
+| Label | required | |
name , Name | required | |
-| bindgen executable. | Label | optional | None |
-| clang executable. | Label | optional | None |
-| rust_bindgen targets will always format generated sources with rustfmt. | Boolean | optional | True |
-| Label | optional | None |
-| Label | optional | None |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
features attribute for the rust_bindgen target. | `None` |
+| rust_library rule. | none |
+| Name | required | |
-| List of labels | optional | [] |
+| List of labels | optional | `[]` |
Name | required | |
+| Name | required | |
diff --git a/docs/rust_doc.md b/docs/rust_doc.md
index c6959c2088..42dff37854 100644
--- a/docs/rust_doc.md
+++ b/docs/rust_doc.md
@@ -49,20 +49,19 @@ rust_doc(
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 | required | |
-| rust_doc can generate HTML code documentation for the source files of rust_library or rust_binary targets. | Label | required | |
-| <body>, after content. | Label | optional | None |
-| <body>, before content. | Label | optional | None |
-| html_in_header | File to add to <head>. | Label | optional | None |
-| <link> in a rendered Markdown file. | List of labels | optional | [] |
-| rustdoc_flags instead | List of strings | optional | [] |
-| rustdoc.$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 | [] |
+| Label | required | |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| html_in_header | File to add to ``. | Label | optional | `None` |
+| List of labels | optional | `[]` |
+|
-rust_doc_test(name , crate , deps )
+rust_doc_test(name , deps , crate )
Runs Rust documentation tests.
@@ -110,14 +109,13 @@ rust_doc_test(
Running `bazel test //hello_lib:hello_lib_doc_test` will run all documentation tests for the `hello_lib` library crate.
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rust_doc_test can generate HTML code documentation for the source files of rust_library or rust_binary targets. | Label | required | |
-| rust_library targets or cc_library targets if linking a native library. | List of labels | optional | [] |
+| List of labels | optional | `[]` |
+| Label | required | |
diff --git a/docs/rust_fmt.md b/docs/rust_fmt.md
index e33b7b8ef2..0bc065347d 100644
--- a/docs/rust_fmt.md
+++ b/docs/rust_fmt.md
@@ -75,7 +75,7 @@ A test rule for performing `rustfmt --check` on a set of targets
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| rustfmt --check on. | List of labels | optional | [] |
+| List of labels | optional | `[]` |
Name | required | |
-| rustc binary. Can be a direct source or a filegroup containing one item. | Label | optional | None |
-| Label | optional | None |
-| rustfmt binary. Can be a direct source or a filegroup containing one item. | Label | required | |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | required | |
Name | required | |
+| Name | required | |
diff --git a/docs/rust_proto.md b/docs/rust_proto.md
index ea5a92b2d9..08eca3759f 100644
--- a/docs/rust_proto.md
+++ b/docs/rust_proto.md
@@ -258,7 +258,7 @@ configuration.
## rust_grpc_library
-rust_grpc_library(name , crate_name , deps , rust_deps , rustc_flags )
+rust_grpc_library(name , deps , crate_name , rust_deps , rustc_flags )
Builds a Rust library crate from a set of `proto_library`s suitable for gRPC.
@@ -285,17 +285,16 @@ rust_binary(
)
```
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| "" |
| List of labels | required | |
-| List of labels | optional | [] |
-| rustc.$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 | [] |
+| List of labels | optional | `[]` |
+| Name | required | |
-| [] |
+| Label | required | |
-| --plugin=protoc-gen-prost=%s) | String | optional | "--plugin=protoc-gen-prost=%s" |
+| Label | required | |
| Label | required | |
| Label | required | |
-| [] |
-| Label | optional | None |
-| --plugin=protoc-gen-tonic=%s)) | String | optional | "--plugin=protoc-gen-tonic=%s" |
-| Label | optional | None |
+| Label | optional | `None` |
+| Label | optional | `None` |
-rust_proto_library(name , crate_name , deps , rust_deps , rustc_flags )
+rust_proto_library(name , deps , crate_name , rust_deps , rustc_flags )
Builds a Rust library crate from a set of `proto_library`s.
@@ -359,17 +358,16 @@ rust_binary(
)
```
-
**ATTRIBUTES**
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| Name | required | |
-| "" |
| List of labels | required | |
-| List of labels | optional | [] |
-| rustc.$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 | [] |
+| List of labels | optional | `[]` |
+| rust_prost_library rule. | none |
+| Name | required | |
-| Label | optional | @rules_rust//ffi/cc/allocator_library |
+| Label | optional | `"@rules_rust//ffi/cc/allocator_library"` |
| cargo binary. Can be a direct source or a filegroup containing one item. | Label | optional | None |
-| clippy-driver binary. Can be a direct source or a filegroup containing one item. | Label | optional | None |
-| Dictionary: String -> String | optional | {"dbg": "2", "fastbuild": "0", "opt": "0"} |
-| edition attribute. | String | optional | "" |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{"dbg": "2", "fastbuild": "0", "opt": "0"}` |
+| Dictionary: String -> String | optional | {} |
+| Dictionary: String -> String | optional | `{}` |
| Label | optional | @rules_rust//rust/settings:experimental_link_std_dylib |
-| Label | optional | //rust/settings:experimental_use_cc_common_link |
-| extra_exec_rustc_flags | Extra flags to pass to rustc in exec configuration | List of strings | optional | [] |
-| extra_rustc_flags | Extra flags to pass to rustc in non-exec configuration | List of strings | optional | [] |
-| extra_rustc_flags_for_crate_types | Extra flags to pass to rustc based on crate type | Dictionary: String -> List of strings | optional | {} |
-| Label | optional | @rules_rust//ffi/cc/global_allocator_library |
-| llvm-cov binary. Can be a direct source or a filegroup containing one item. If None, rust code is not instrumented for coverage. | Label | optional | None |
-| llvm-profdata binary. Can be a direct source or a filegroup containing one item. If llvm_cov is None, this can be None as well and rust code is not instrumented for coverage. | Label | optional | None |
-| Label | optional | None |
-| Dictionary: String -> String | optional | {"dbg": "0", "fastbuild": "0", "opt": "3"} |
-| [] |
-| rustdoc binary. Can be a direct source or a filegroup containing one item. | Label | required | |
+| Label | optional | `"@rules_rust//rust/settings:experimental_link_std_dylib"` |
+| Label | optional | `"@rules_rust//rust/settings:experimental_use_cc_common_link"` |
+| extra_exec_rustc_flags | Extra flags to pass to rustc in exec configuration | List of strings | optional | `[]` |
+| extra_rustc_flags | Extra flags to pass to rustc in non-exec configuration | List of strings | optional | `[]` |
+| extra_rustc_flags_for_crate_types | Extra flags to pass to rustc based on crate type | Dictionary: String -> List of strings | optional | `{}` |
+| Label | optional | `"@rules_rust//ffi/cc/global_allocator_library"` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Label | optional | `None` |
+| Dictionary: String -> String | optional | `{"dbg": "0", "fastbuild": "0", "opt": "3"}` |
+| Label | required | |
| Label | required | |
-| rustc binary. Can be a direct source or a filegroup containing one item. | Label | required | |
-| Label | optional | None |
-| Label | optional | None |
+| Label | required | |
+| Label | optional | `None` |
+| Label | optional | `None` |
| rust_std attribute. | List of strings | required | |
-| Dictionary: String -> String | optional | {"dbg": "none", "fastbuild": "none", "opt": "debuginfo"} |
-| "" |
-| "" |
-
-
-
-rust_toolchain_repository_proxy(name , exec_compatible_with , repo_mapping , target_compatible_with ,
- target_settings , toolchain , toolchain_type )
-
-
-Generates a toolchain-bearing repository that declares the toolchains from some other rust_toolchain_repository.
-
-**ATTRIBUTES**
-
-
-| Name | Description | Type | Mandatory | Default |
-| :------------- | :------------- | :------------- | :------------- | :------------- |
-| Name | required | |
-| [] |
-| "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | |
-| [] |
-| [] |
-|
-rust_toolchain_tools_repository(name , allocator_library , auth , auth_patterns , dev_components ,
- edition , exec_triple , extra_exec_rustc_flags , extra_rustc_flags ,
- global_allocator_library , iso_date , netrc , opt_level , repo_mapping ,
- rustfmt_version , sha256s , target_triple , urls , version )
-
-
-Composes a single workspace containing the toolchain components for compiling on a given platform to a series of target platforms.
-
-A given instance of this rule should be accompanied by a toolchain_repository_proxy invocation to declare its toolchains to Bazel; the indirection allows separating toolchain selection from toolchain fetching.
-
-**ATTRIBUTES**
-
-
-| Name | Description | Type | Mandatory | Default |
-| :------------- | :------------- | :------------- | :------------- | :------------- |
-| Name | required | |
-| "@rules_rust//ffi/cc/allocator_library" |
-| Dictionary: String -> String | optional | {} |
-| [] |
-| False |
-| edition attribute. | String | optional | "" |
-| [] |
-| extra_rustc_flags | Extra flags to pass to rustc in non-exec configuration | List of strings | optional | [] |
-| "@rules_rust//ffi/cc/global_allocator_library" |
-| "" |
-| "" |
-| rust_toolchain.opt_level. | Dictionary: String -> String | optional | {} |
-| "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | |
-| "" |
-| Dictionary: String -> String | optional | {} |
-| ["https://static.rust-lang.org/dist/{}.tar.xz"] |
-| Dictionary: String -> String | optional | `{"dbg": "none", "fastbuild": "none", "opt": "debuginfo"}` |
+| edition attribute. | `None` |
+| versions instead. | `None` |
-| rust_toolchain targets. | `True` |
-| versions is given, then this defaults to that version, otherwise will default to the default nightly version. | `None` |
+| versions instead. | `None` |
-| ["1.65.0", "nightly/2022-11-02", "beta/2020-12-30"]. | `[]` |
+| kwargs )
| Name | Description | Default Value |
| :------------- | :------------- | :------------- |
-| rust_register_toolchains macro. | none |
+| ["1.65.0", "nightly/2022-11-02", "beta/2020-12-30"]. | `[]` |
+| edition attribute. | `None` |
+| rust_toolchain target will become a registered toolchain. | `True` |
+| edition attribute. | `None` |
+|
+rust_toolchain_repository_proxy(name , exec_compatible_with , repo_mapping , target_compatible_with ,
+ target_settings , toolchain , toolchain_type )
+
+
+Generates a toolchain-bearing repository that declares the toolchains from some other rust_toolchain_repository.
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| Name | required | |
+| Dictionary: String -> String | optional | |
+|
+rust_toolchain_tools_repository(name , allocator_library , auth , auth_patterns , dev_components ,
+ edition , exec_triple , extra_exec_rustc_flags , extra_rustc_flags ,
+ global_allocator_library , iso_date , netrc , opt_level , repo_mapping ,
+ rustfmt_version , sha256s , target_triple , urls , version )
+
+
+Composes a single workspace containing the toolchain components for compiling on a given platform to a series of target platforms.
+
+A given instance of this rule should be accompanied by a toolchain_repository_proxy invocation to declare its toolchains to Bazel; the indirection allows separating toolchain selection from toolchain fetching.
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| Name | required | |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | `{}` |
+| Dictionary: String -> String | optional | |
+| Dictionary: String -> String | optional | `{}` |
+| Name | required | |
-| [] |
-| "bundler" |
-| .wasm file or crate to generate bindings for. | Label | required | |
+| Label | required | |
Name | required | |
-| wasm-bindgen-cli executable. | Label | optional | None |
+| Label | optional | `None` |
wasm-bindgen. |
-| wasm-bindgen. |
-| .wasm file generated by wasm-bindgen. |
+|