rust_cdylib_library
rust_cdylib_library
load("@rules_rust//rust:rust_cdylib_library.bzl", "rust_cdylib_library")
rust_cdylib_library(name, deps, srcs, data, aliases, allocator_libraries, alwayslink, compile_data,
crate_features, crate_name, crate_root, edition, experimental_use_cc_common_link,
link_deps, lint_config, malloc, platform, proc_macro_deps,
require_explicit_unstable_features, root_path, rustc_env, rustc_env_files,
rustc_flags, stamp, unstable_rust_features_config, version, zself_profile_events)
Builds a C ABI Rust shared library.
This shared library will contain all transitively reachable crates and native objects. It is meant to be used when producing an artifact that is then consumed by some other build system (for example to produce a shared library that Python program links against).
This rule provides CcInfo, so it can be used everywhere Bazel expects rules_cc.
When building the whole binary in Bazel, use rust_library instead.
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| name | A unique name for this target. | Name | required | |
| deps | List of other Rust libraries to be linked to this library target. These must be targets that provide CrateInfo, such as rust_library. | List of labels | optional | [] |
| srcs | List of Rust .rs source files used to build the library.If srcs contains more than one file, then there must be a file either named lib.rs. Otherwise, crate_root must be set to the source file that is the root of the crate to be passed to rustc to build this crate. | List of labels | optional | [] |
| data | List of files used by this rule at compile time and runtime. If including data at compile time with include_str!() and similar, prefer compile_data over data, to prevent the data also being included in the runfiles. | List of labels | optional | [] |
| aliases | Remap crates to a new name or moniker for linkage to this target These are other rust_library targets and will be presented as the new name given. | Dictionary: Label -> String | optional | {} |
| allocator_libraries | - | Label | optional | "@rules_rust//ffi/rs:default_allocator_libraries" |
| alwayslink | If 1, any binary that depends (directly or indirectly) on this library will link in all the object files even if some contain no symbols referenced by the binary. This attribute is used by the C++ Starlark API when passing CcInfo providers. | Boolean | optional | False |
| compile_data | List of files used by this rule at compile time. This attribute can be used to specify any data files that are embedded into the library, such as via the include_str! macro. | List of labels | optional | [] |
| crate_features | List of features to enable for this crate. Features are defined in the code using the #[cfg(feature = "foo")] configuration option. The features listed here will be passed to rustc with --cfg feature="${feature_name}" flags. | List of strings | optional | [] |
| crate_name | Crate name to use for this target. This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores. | String | optional | "" |
| crate_root | The file that will be passed to rustc to be used for building this crate.If crate_root is not set, then this rule will look for a lib.rs file (or main.rs for rust_binary) or the single file in srcs if srcs contains only one file.If the srcs contains only one file and that file is a directory, use root_path to specify the path to the crate root .rs file under that directory. | Label | optional | None |
| edition | The rust edition to use for this crate. Defaults to the edition specified in the rust_toolchain. | String | optional | "" |
| experimental_use_cc_common_link | Whether to use cc_common.link to link rust binaries. Possible values: [-1, 0, 1]. -1 means use the value of the toolchain.experimental_use_cc_common_link boolean build setting to determine. 0 means do not use cc_common.link (use rustc instead). 1 means use cc_common.link. | Integer | optional | -1 |
| link_deps | List of other native libraries to be linked to this library target. These are typically cc_library targets. | List of labels | optional | [] |
| lint_config | Set of lints to apply when building this crate. | Label | optional | None |
| malloc | Override the default dependency on malloc.By default, Rust binaries linked with cc_common.link are linked against @rules_rust//rust/private/cc: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 | "@rules_rust//rust/private/cc:malloc" |
| platform | Optional platform to transition the static library to. | Label | optional | None |
| proc_macro_deps | List of rust_proc_macro targets used to help build this library target. | List of labels | optional | [] |
| require_explicit_unstable_features | Whether to require all unstable features to be explicitly opted in to using -Zallow-features=.... Possible values: [-1, 0, 1]. -1 means delegate to the toolchain.require_explicit_unstable_features boolean build setting; 0 means False; 1 means True. | Integer | optional | -1 |
| root_path | If the crate root (single member of the srcs list) is a directory, this is the path to the crate root .rs file under that directory. | String | optional | "" |
| rustc_env | Dictionary of additional "key": "value" environment variables to set for rustc.rust_test()/rust_binary() rules can use $(rootpath //package:target) to pass in the location of a generated file or external tool. Cargo build scripts that wish to expand locations should use cargo_build_script()'s build_script_env argument instead, as build scripts are run in a different environment - see cargo_build_script()'s documentation for more. | Dictionary: String -> String | optional | {} |
| rustc_env_files | Files containing additional environment variables to set for rustc. These files should contain a single variable per line, of format NAME=value, and newlines may be included in a value by ending a line with a trailing back-slash (\\).The order that these files will be processed is unspecified, so multiple definitions of a particular variable are discouraged. Note that the variables here are subject to workspace status stamping should the stamp attribute be enabled. Stamp variables should be wrapped in brackets in order to be resolved. E.g. NAME={WORKSPACE_STATUS_VARIABLE}. | List of labels | optional | [] |
| rustc_flags | List of compiler flags passed to rustc.These strings are subject to Make variable expansion for predefined source/output path variables like $location, $execpath, and $rootpath. This expansion is useful if you wish to pass a generated file of arguments to rustc: @$(location //package:target). | List of strings | optional | [] |
| stamp | Whether to encode build information into the Rustc action. Possible values:- stamp = 1: Always stamp the build information into the Rustc action, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.- stamp = 0: Always replace build information by constant values. This gives good build result caching.- stamp = -1: Embedding of build information is controlled by the --[no]stamp flag.Stamped targets are not rebuilt unless their dependencies change. For example if a rust_library is stamped, and a rust_binary depends on that library, the stamped library won't be rebuilt when we change sources of the rust_binary. This is different from how cc_library.linkstamps behaves. | Integer | optional | 0 |
| unstable_rust_features_config | Controls which unstable features are allowed to be used by this target. Setting this to anything other than None requires a nightly toolchain. | Label | optional | None |
| version | A version to inject in the cargo environment variable. | String | optional | "0.0.0" |
| zself_profile_events | Passes -Zself-profile and -Zself-profile-events flag to rustc, requires a nightly toolchain. | Label | optional | None |