Bazel Central Registry

rules_rsAPI docs @0.0.11

@rules_rs//rs:extensions.bzl

Module Extensions

crate

Tag Classes

annotation

A collection of extra attributes and settings for a particular crate.

Attribute	Type	Description
`*crate`	`string`	The name of the crate the annotation is applied to
`repositories`	`list of strings`	A list of repository names specified from `crate.from_cargo(name=...)` that this annotation is applied to. Defaults to all repositories. Default: `[]`
`additive_build_file`	`label`	A file containing extra contents to write to the bottom of generated BUILD files. Default: `None`
`additive_build_file_content`	`string`	Extra contents to write to the bottom of generated BUILD files. Default: `""`
`build_script_data`	`list of strings`	A list of labels to add to a crate's `cargo_build_script::data` attribute. Default: `[]`
`build_script_data_select`	`dictionary: String → List of strings`	A list of labels to add to a crate's `cargo_build_script::data` attribute. Keys should be the platform triplet. Value should be a list of labels. Default: `{}`
`build_script_env`	`dictionary: String → String`	Additional environment variables to set on a crate's `cargo_build_script::env` attribute. Default: `{}`
`build_script_env_select`	`dictionary: String → String`	Additional environment variables to set on a crate's `cargo_build_script::env` attribute. Key should be the platform triplet. Value should be a JSON encoded dictionary mapping variable names to values, for example `{"FOO": "bar"}`. Default: `{}`
`build_script_toolchains`	`list of labels`	A list of labels to set on a crates's `cargo_build_script::toolchains` attribute. Default: `[]`
`crate_features`	`list of strings`	A list of strings to add to a crate's `rust_library::crate_features` attribute. Default: `[]`
`data`	`list of strings`	A list of labels to add to a crate's `rust_library::data` attribute. Default: `[]`
`deps`	`list of strings`	A list of labels to add to a crate's `rust_library::deps` attribute. Default: `[]`
`gen_build_script`	`string`	An authoritative flag to determine whether or not to produce `cargo_build_script` targets for the current crate. Supported values are 'on', 'off', and 'auto'. Default: `"auto"`
`patch_args`	`list of strings`	The `patch_args` attribute of a Bazel repository rule. See http_archive.patch_args Default: `[]`
`patch_tool`	`string`	The `patch_tool` attribute of a Bazel repository rule. See http_archive.patch_tool Default: `""`
`patches`	`list of labels`	The `patches` attribute of a Bazel repository rule. See http_archive.patches Default: `[]`
`rustc_flags`	`list of strings`	A list of strings to set on a crate's `rust_library::rustc_flags` attribute. Default: `[]`
`strip_prefix`	`string`	Default: `""`
`workspace_cargo_toml`	`string`	For crates from git, the ruleset assumes the (workspace) Cargo.toml is in the repo root. This attribute overrides the assumption. Default: `"Cargo.toml"`

from_cargo

Generates a repo @crates from a Cargo.toml / Cargo.lock pair.

Attribute	Type	Description
`name`	`name`	The name of the repo to generate Default: `"crates"`
`cargo_toml`	`label`	The workspace-level Cargo.toml. There can be multiple crates in the workspace. Default: `None`
`cargo_lock`	`label`	Default: `None`
`cargo_config`	`label`	Default: `None`
`use_home_cargo_credentials`	`boolean`	If set, the ruleset will load `~/cargo/credentials.toml` and attach those credentials to registry requests. Default: `False`
`*platform_triples`	`list of strings`	The set of triples to resolve for. They must correspond to the union of any exec/target platforms that will participate in your build.
`debug`	`boolean`	Default: `False`