<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/cargo.md - fork/rules_rust @ main</title>
<meta name="description" content="docs/src/cargo.md in fork/rules_rust at main.">
<meta property="og:title" content="docs/src/cargo.md - fork/rules_rust @ main">
<meta property="og:description" content="docs/src/cargo.md in fork/rules_rust at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="c07cb1b5e1bec3184239c28bdddd6c5a0a97d634">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">UebelAndre</span><span class="commit-message" data-commit="8e962a16d9f4a243e739320015b5d7f5c357cc68">Added support for compact windows repository names, avoiding MAX_PATH (#3023)</span><span class="snapshot-sha sha" data-commit="8e962a16d9f4a243e739320015b5d7f5c357cc68">8e962a16</span><time datetime="2024-12-04T13:25:54-08:00" title="2024-12-04 13:25:54 -0800">2024-12-04</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a class="current" href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/main/tree/docs/">docs</a> / <a href="/fork/rules_rust/ref/main/tree/docs/src/">src</a> / <span class="cur">cargo.md</span></nav>
<span class="view-stats"><span>15.7 KiB</span><span>210 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/b82f17dee24e755b1f81fbb4fe832a77c613182b/docs/src/cargo.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;
<h1>Cargo</h1>
<ul>
<li><a href="#cargo_bootstrap_repository">cargo_bootstrap_repository</a></li>
<li><a href="#cargo_build_script">cargo_build_script</a></li>
<li><a href="#cargo_dep_env">cargo_dep_env</a></li>
<li><a href="#cargo_env">cargo_env</a></li>
</ul>
<p>&lt;a id="cargo_dep_env"&gt;&lt;/a&gt;</p>
<h2>cargo_dep_env</h2>
&lt;pre&gt;
cargo_dep_env(&lt;a href="#cargo_dep_env-name"&gt;name&lt;/a&gt;, &lt;a href="#cargo_dep_env-src"&gt;src&lt;/a&gt;, &lt;a href="#cargo_dep_env-out_dir"&gt;out_dir&lt;/a&gt;)
&lt;/pre&gt;
<p>A rule for generating variables for dependent <code>cargo_build_script</code>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.</p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="cargo_dep_env-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_dep_env-src"&gt;&lt;/a&gt;src</td><td style="text-align: left">File containing additional environment variables to set for build scripts of direct dependencies.&lt;br&gt;&lt;br&gt;This has the same effect as a <code>cargo_build_script</code> which prints <code>cargo:VAR=VALUE</code> lines, but without requiring a build script.&lt;br&gt;&lt;br&gt;This files should  contain a single variable per line, of format <code>NAME=value</code>, and newlines may be included in a value by ending a line with a trailing back-slash (<code>\\</code>).</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_dep_env-out_dir"&gt;&lt;/a&gt;out_dir</td><td style="text-align: left">Folder containing additional inputs when building all direct dependencies.&lt;br&gt;&lt;br&gt;This has the same effect as a <code>cargo_build_script</code> which prints puts files into <code>$OUT_DIR</code>, but without requiring a build script.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p>&lt;a id="cargo_build_script"&gt;&lt;/a&gt;</p>
<h2>cargo_build_script</h2>
&lt;pre&gt;
cargo_build_script(&lt;a href="#cargo_build_script-name"&gt;name&lt;/a&gt;, &lt;a href="#cargo_build_script-edition"&gt;edition&lt;/a&gt;, &lt;a href="#cargo_build_script-crate_name"&gt;crate_name&lt;/a&gt;, &lt;a href="#cargo_build_script-crate_root"&gt;crate_root&lt;/a&gt;, &lt;a href="#cargo_build_script-srcs"&gt;srcs&lt;/a&gt;, &lt;a href="#cargo_build_script-crate_features"&gt;crate_features&lt;/a&gt;, &lt;a href="#cargo_build_script-version"&gt;version&lt;/a&gt;, &lt;a href="#cargo_build_script-deps"&gt;deps&lt;/a&gt;,
                   &lt;a href="#cargo_build_script-link_deps"&gt;link_deps&lt;/a&gt;, &lt;a href="#cargo_build_script-proc_macro_deps"&gt;proc_macro_deps&lt;/a&gt;, &lt;a href="#cargo_build_script-build_script_env"&gt;build_script_env&lt;/a&gt;, &lt;a href="#cargo_build_script-data"&gt;data&lt;/a&gt;, &lt;a href="#cargo_build_script-compile_data"&gt;compile_data&lt;/a&gt;, &lt;a href="#cargo_build_script-tools"&gt;tools&lt;/a&gt;, &lt;a href="#cargo_build_script-links"&gt;links&lt;/a&gt;,
                   &lt;a href="#cargo_build_script-rundir"&gt;rundir&lt;/a&gt;, &lt;a href="#cargo_build_script-rustc_env"&gt;rustc_env&lt;/a&gt;, &lt;a href="#cargo_build_script-rustc_env_files"&gt;rustc_env_files&lt;/a&gt;, &lt;a href="#cargo_build_script-rustc_flags"&gt;rustc_flags&lt;/a&gt;, &lt;a href="#cargo_build_script-visibility"&gt;visibility&lt;/a&gt;, &lt;a href="#cargo_build_script-tags"&gt;tags&lt;/a&gt;, &lt;a href="#cargo_build_script-aliases"&gt;aliases&lt;/a&gt;,
                   &lt;a href="#cargo_build_script-pkg_name"&gt;pkg_name&lt;/a&gt;, &lt;a href="#cargo_build_script-kwargs"&gt;kwargs&lt;/a&gt;)
&lt;/pre&gt;
<p>Compile and execute a rust build script to generate build attributes</p>
<p>This rules take the same arguments as rust_binary.</p>
<p>Example:</p>
<p>Suppose you have a crate with a cargo build script <code>build.rs</code>:</p>
<pre>[workspace]/
    hello_lib/
        BUILD
        build.rs
        src/
            lib.rs
</pre>
<p>Then you want to use the build script in the following:</p>
<p><code>hello_lib/BUILD</code>:</p>
<pre class="language-python"><a-f>package</a-f>(<a-v>default_visibility</a-v> <a-o>=</a-o> [<a-s>&quot;//visibility:public&quot;</a-s>])

<a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s>, <a-s>&quot;rust_binary&quot;</a-s>, <a-s>&quot;rust_library&quot;</a-s>)
<a-f>load</a-f>(<a-s>&quot;@rules_rust//cargo:defs.bzl&quot;</a-s>, <a-s>&quot;cargo_build_script&quot;</a-s>)

<a-c># This will run the build script from the root of the workspace, and</a-c>
<a-c># collect the outputs.</a-c>
<a-f>cargo_build_script</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;build_script&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;build.rs&quot;</a-s>],
    <a-c># Optional environment variables passed during build.rs compilation</a-c>
    <a-v>rustc_env</a-v> <a-o>=</a-o> {
       <a-s>&quot;CARGO_PKG_VERSION&quot;</a-s>: <a-s>&quot;0.1.2&quot;</a-s>,
    },
    <a-c># Optional environment variables passed during build.rs execution.</a-c>
    <a-c># Note that as the build script&#39;s working directory is not execroot,</a-c>
    <a-c># execpath/location will return an absolute path, instead of a relative</a-c>
    <a-c># one.</a-c>
    <a-v>build_script_env</a-v> <a-o>=</a-o> {
        <a-s>&quot;SOME_TOOL_OR_FILE&quot;</a-s>: <a-s>&quot;$(execpath @tool//:binary)&quot;</a-s>
    },
    <a-c># Optional data/tool dependencies</a-c>
    <a-v>data</a-v> <a-o>=</a-o> [<a-s>&quot;@tool//:binary&quot;</a-s>],
)

<a-f>rust_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;hello_lib&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [
        <a-s>&quot;src/lib.rs&quot;</a-s>,
    ],
    <a-v>deps</a-v> <a-o>=</a-o> [<a-s>&quot;:build_script&quot;</a-s>],
)</pre>
<p>The <code>hello_lib</code> target will be build with the flags and the environment variables declared by the     build script in addition to the file generated by it.</p>
<p><strong>PARAMETERS</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Default Value</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">The name for the underlying rule. This should be the name of the package being compiled, optionally with a suffix of <code>_bs</code>. Otherwise, you can set the package name via <code>pkg_name</code>.</td><td style="text-align: left">none</td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-edition"&gt;&lt;/a&gt;edition</td><td style="text-align: left">The rust edition to use for the internal binary crate.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-crate_name"&gt;&lt;/a&gt;crate_name</td><td style="text-align: left">Crate name to use for build script.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-crate_root"&gt;&lt;/a&gt;crate_root</td><td style="text-align: left">The file that will be passed to rustc to be used for building this crate.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-srcs"&gt;&lt;/a&gt;srcs</td><td style="text-align: left">Souce files of the crate to build. Passing source files here can be used to trigger rebuilds when changes are made.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-crate_features"&gt;&lt;/a&gt;crate_features</td><td style="text-align: left">A list of features to enable for the build script.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-version"&gt;&lt;/a&gt;version</td><td style="text-align: left">The semantic version (semver) of the crate.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-deps"&gt;&lt;/a&gt;deps</td><td style="text-align: left">The build-dependencies of the crate.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-link_deps"&gt;&lt;/a&gt;link_deps</td><td style="text-align: left">The subset of the (normal) dependencies of the crate that have the links attribute and therefore provide environment variables to this build script.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-proc_macro_deps"&gt;&lt;/a&gt;proc_macro_deps</td><td style="text-align: left">List of rust_proc_macro targets used to build the script.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-build_script_env"&gt;&lt;/a&gt;build_script_env</td><td style="text-align: left">Environment variables for build scripts.</td><td style="text-align: left"><code>{}</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-data"&gt;&lt;/a&gt;data</td><td style="text-align: left">Files needed by the build script.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-compile_data"&gt;&lt;/a&gt;compile_data</td><td style="text-align: left">Files needed for the compilation of the build script.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-tools"&gt;&lt;/a&gt;tools</td><td style="text-align: left">Tools (executables) needed by the build script.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-links"&gt;&lt;/a&gt;links</td><td style="text-align: left">Name of the native library this crate links against.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-rundir"&gt;&lt;/a&gt;rundir</td><td style="text-align: left">A directory to <code>cd</code> to before the cargo_build_script is run. This should be a path relative to the exec root.&lt;br&gt;&lt;br&gt;The default behaviour (and the behaviour if rundir is set to the empty string) is to change to the relative path corresponding to the cargo manifest directory, which replicates the normal behaviour of cargo so it is easy to write compatible build scripts.&lt;br&gt;&lt;br&gt;If set to <code>.</code>, the cargo build script will run in the exec root.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-rustc_env"&gt;&lt;/a&gt;rustc_env</td><td style="text-align: left">Environment variables to set in rustc when compiling the build script.</td><td style="text-align: left"><code>{}</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-rustc_env_files"&gt;&lt;/a&gt;rustc_env_files</td><td style="text-align: left">Files containing additional environment variables to set for rustc when building the build script.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-rustc_flags"&gt;&lt;/a&gt;rustc_flags</td><td style="text-align: left">List of compiler flags passed to <code>rustc</code>.</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-visibility"&gt;&lt;/a&gt;visibility</td><td style="text-align: left">Visibility to apply to the generated build script output.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-tags"&gt;&lt;/a&gt;tags</td><td style="text-align: left">(list of str, optional): Tags to apply to the generated build script output.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-aliases"&gt;&lt;/a&gt;aliases</td><td style="text-align: left">Remap crates to a new name or moniker for linkage to this target.             These are other <code>rust_library</code> targets and will be presented as the new name given.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-pkg_name"&gt;&lt;/a&gt;pkg_name</td><td style="text-align: left">Override the package name used for the build script. This is useful if the build target name gets too long otherwise.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_build_script-kwargs"&gt;&lt;/a&gt;kwargs</td><td style="text-align: left">Forwards to the underlying <code>rust_binary</code> rule. An exception is the <code>compatible_with</code> attribute, which shouldn't be forwarded to the <code>rust_binary</code>, as the <code>rust_binary</code> is only built and used in <code>exec</code> mode. We propagate the <code>compatible_with</code> attribute to the <code>_build_scirpt_run</code> target.</td><td style="text-align: left">none</td></tr>
</tbody></table>
<p>&lt;a id="cargo_env"&gt;&lt;/a&gt;</p>
<h2>cargo_env</h2>
&lt;pre&gt;
cargo_env(&lt;a href="#cargo_env-env"&gt;env&lt;/a&gt;)
&lt;/pre&gt;
<p>A helper for generating platform specific environment variables</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s>, <a-s>&quot;rust_common&quot;</a-s>)
<a-f>load</a-f>(<a-s>&quot;@rules_rust//cargo:defs.bzl&quot;</a-s>, <a-s>&quot;cargo_bootstrap_repository&quot;</a-s>, <a-s>&quot;cargo_env&quot;</a-s>)

<a-f>cargo_bootstrap_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;bootstrapped_bin&quot;</a-s>,
    <a-v>cargo_lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.lock&quot;</a-s>,
    <a-v>cargo_toml</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.toml&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;//:resolver_srcs&quot;</a-s>],
    <a-v>version</a-v> <a-o>=</a-o> <a-v>rust_common</a-v>.<a-pr>default_version</a-pr>,
    <a-v>binary</a-v> <a-o>=</a-o> <a-s>&quot;my-crate-binary&quot;</a-s>,
    <a-v>env</a-v> <a-o>=</a-o> {
        <a-s>&quot;x86_64-unknown-linux-gnu&quot;</a-s>: <a-f>cargo_env</a-f>({
            <a-s>&quot;FOO&quot;</a-s>: <a-s>&quot;BAR&quot;</a-s>,
        }),
    },
    <a-v>env_label</a-v> <a-o>=</a-o> {
        <a-s>&quot;aarch64-unknown-linux-musl&quot;</a-s>: <a-f>cargo_env</a-f>({
            <a-s>&quot;DOC&quot;</a-s>: <a-s>&quot;//:README.md&quot;</a-s>,
        }),
    }
)</pre>
<p><strong>PARAMETERS</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Default Value</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="cargo_env-env"&gt;&lt;/a&gt;env</td><td style="text-align: left">A map of environment variables</td><td style="text-align: left">none</td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>str: A json encoded string of the environment variables</p>
<p>&lt;a id="cargo_bootstrap_repository"&gt;&lt;/a&gt;</p>
<h2>cargo_bootstrap_repository</h2>
&lt;pre&gt;
cargo_bootstrap_repository(&lt;a href="#cargo_bootstrap_repository-name"&gt;name&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-srcs"&gt;srcs&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-binary"&gt;binary&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-build_mode"&gt;build_mode&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-cargo_config"&gt;cargo_config&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-cargo_lockfile"&gt;cargo_lockfile&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-cargo_toml"&gt;cargo_toml&lt;/a&gt;,
                           &lt;a href="#cargo_bootstrap_repository-compressed_windows_toolchain_names"&gt;compressed_windows_toolchain_names&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-env"&gt;env&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-env_label"&gt;env_label&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-repo_mapping"&gt;repo_mapping&lt;/a&gt;,
                           &lt;a href="#cargo_bootstrap_repository-rust_toolchain_cargo_template"&gt;rust_toolchain_cargo_template&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-rust_toolchain_rustc_template"&gt;rust_toolchain_rustc_template&lt;/a&gt;, &lt;a href="#cargo_bootstrap_repository-timeout"&gt;timeout&lt;/a&gt;,
                           &lt;a href="#cargo_bootstrap_repository-version"&gt;version&lt;/a&gt;)
&lt;/pre&gt;
<p>A rule for bootstrapping a Rust binary using <a href="https://doc.rust-lang.org/cargo/">Cargo</a></p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this repository.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-srcs"&gt;&lt;/a&gt;srcs</td><td style="text-align: left">Souce files of the crate to build. Passing source files here can be used to trigger rebuilds when changes are made</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;List of labels&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-binary"&gt;&lt;/a&gt;binary</td><td style="text-align: left">The binary to build (the <code>--bin</code> parameter for Cargo). If left empty, the repository name will be used.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>""</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-build_mode"&gt;&lt;/a&gt;build_mode</td><td style="text-align: left">The build mode the binary should be built with</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"release"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-cargo_config"&gt;&lt;/a&gt;cargo_config</td><td style="text-align: left">The path of the Cargo configuration (<code>Config.toml</code>) file.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-cargo_lockfile"&gt;&lt;/a&gt;cargo_lockfile</td><td style="text-align: left">The lockfile of the crate_universe resolver</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-cargo_toml"&gt;&lt;/a&gt;cargo_toml</td><td style="text-align: left">The path of the <code>Cargo.toml</code> file.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-compressed_windows_toolchain_names"&gt;&lt;/a&gt;compressed_windows_toolchain_names</td><td style="text-align: left">Wether or not the toolchain names of windows toolchains are expected to be in a <code>compressed</code> format.</td><td style="text-align: left">Boolean</td><td style="text-align: left">optional</td><td style="text-align: left"><code>True</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-env"&gt;&lt;/a&gt;env</td><td style="text-align: left">A mapping of platform triple to a set of environment variables. See <a href="#cargo_env">cargo_env</a> for usage details. Additionally, the platform triple <code>*</code> applies to all platforms.</td><td style="text-align: left">&lt;a href="https://bazel.build/rules/lib/dict"&gt;Dictionary: String -&gt; String&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>{}</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-env_label"&gt;&lt;/a&gt;env_label</td><td style="text-align: left">A mapping of platform triple to a set of environment variables. This attribute differs from <code>env</code> in that all variables passed here must be fully qualified labels of files. See <a href="#cargo_env">cargo_env</a> for usage details. Additionally, the platform triple <code>*</code> applies to all platforms.</td><td style="text-align: left">&lt;a href="https://bazel.build/rules/lib/dict"&gt;Dictionary: String -&gt; String&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>{}</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-repo_mapping"&gt;&lt;/a&gt;repo_mapping</td><td style="text-align: left">In <code>WORKSPACE</code> context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.&lt;br&gt;&lt;br&gt;For example, an entry <code>"@foo": "@bar"</code> declares that, for any time this repository depends on <code>@foo</code> (such as a dependency on <code>@foo//some:target</code>, it should actually resolve that dependency within globally-declared <code>@bar</code> (<code>@bar//some:target</code>).&lt;br&gt;&lt;br&gt;This attribute is <em>not</em> supported in <code>MODULE.bazel</code> context (when invoking a repository rule inside a module extension's implementation function).</td><td style="text-align: left">&lt;a href="https://bazel.build/rules/lib/dict"&gt;Dictionary: String -&gt; String&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-rust_toolchain_cargo_template"&gt;&lt;/a&gt;rust_toolchain_cargo_template</td><td style="text-align: left">The template to use for finding the host <code>cargo</code> binary. <code>{version}</code> (eg. '1.53.0'), <code>{triple}</code> (eg. 'x86_64-unknown-linux-gnu'), <code>{arch}</code> (eg. 'aarch64'), <code>{vendor}</code> (eg. 'unknown'), <code>{system}</code> (eg. 'darwin'), <code>{channel}</code> (eg. 'stable'), and <code>{tool}</code> (eg. 'rustc.exe') will be replaced in the string if present.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-rust_toolchain_rustc_template"&gt;&lt;/a&gt;rust_toolchain_rustc_template</td><td style="text-align: left">The template to use for finding the host <code>rustc</code> binary. <code>{version}</code> (eg. '1.53.0'), <code>{triple}</code> (eg. 'x86_64-unknown-linux-gnu'), <code>{arch}</code> (eg. 'aarch64'), <code>{vendor}</code> (eg. 'unknown'), <code>{system}</code> (eg. 'darwin'), <code>{channel}</code> (eg. 'stable'), and <code>{tool}</code> (eg. 'rustc.exe') will be replaced in the string if present.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-timeout"&gt;&lt;/a&gt;timeout</td><td style="text-align: left">Maximum duration of the Cargo build command in seconds</td><td style="text-align: left">Integer</td><td style="text-align: left">optional</td><td style="text-align: left"><code>600</code></td></tr>
<tr><td style="text-align: left">&lt;a id="cargo_bootstrap_repository-version"&gt;&lt;/a&gt;version</td><td style="text-align: left">The version of Rust the currently registered toolchain is using. Eg. <code>1.56.0</code>, or <code>nightly/2021-09-08</code></td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"1.83.0"</code></td></tr>
</tbody></table>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>#</a-p> <a-tt>Cargo</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>* </a-p>[cargo_bootstrap_repository](#cargo_bootstrap_repository)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>* </a-p>[cargo_build_script](#cargo_build_script)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>* </a-p>[cargo_dep_env](#cargo_dep_env)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>* </a-p>[cargo_env](#cargo_env)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>&lt;a id=&quot;cargo_dep_env&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>## </a-p><a-tt>cargo_dep_env</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>cargo_dep_env(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_dep_env-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_dep_env-src</a-s><a-p>&quot;&gt;src&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_dep_env-out_dir</a-s><a-p>&quot;&gt;out_dir&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>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.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>**ATTRIBUTES**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>| Name  | Description | Type | Mandatory | Default |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_dep_env-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_dep_env-src&quot;&gt;&lt;/a&gt;src |  File containing additional environment variables to set for build scripts of direct dependencies.&lt;br&gt;&lt;br&gt;This has the same effect as a `cargo_build_script` which prints `cargo:VAR=VALUE` lines, but without requiring a build script.&lt;br&gt;&lt;br&gt;This 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 (`\\`).   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_dep_env-out_dir&quot;&gt;&lt;/a&gt;out_dir |  Folder containing additional inputs when building all direct dependencies.&lt;br&gt;&lt;br&gt;This has the same effect as a `cargo_build_script` which prints puts files into `$OUT_DIR`, but without requiring a build script.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>&lt;a id=&quot;cargo_build_script&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>## </a-p><a-tt>cargo_build_script</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>cargo_build_script(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-edition</a-s><a-p>&quot;&gt;edition&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-crate_name</a-s><a-p>&quot;&gt;crate_name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-crate_root</a-s><a-p>&quot;&gt;crate_root&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-srcs</a-s><a-p>&quot;&gt;srcs&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-crate_features</a-s><a-p>&quot;&gt;crate_features&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-version</a-s><a-p>&quot;&gt;version&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-deps</a-s><a-p>&quot;&gt;deps&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>                   &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-link_deps</a-s><a-p>&quot;&gt;link_deps&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-proc_macro_deps</a-s><a-p>&quot;&gt;proc_macro_deps&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-build_script_env</a-s><a-p>&quot;&gt;build_script_env&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-data</a-s><a-p>&quot;&gt;data&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-compile_data</a-s><a-p>&quot;&gt;compile_data&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-tools</a-s><a-p>&quot;&gt;tools&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-links</a-s><a-p>&quot;&gt;links&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>                   &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-rundir</a-s><a-p>&quot;&gt;rundir&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-rustc_env</a-s><a-p>&quot;&gt;rustc_env&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-rustc_env_files</a-s><a-p>&quot;&gt;rustc_env_files&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-rustc_flags</a-s><a-p>&quot;&gt;rustc_flags&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-visibility</a-s><a-p>&quot;&gt;visibility&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-tags</a-s><a-p>&quot;&gt;tags&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-aliases</a-s><a-p>&quot;&gt;aliases&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>                   &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-pkg_name</a-s><a-p>&quot;&gt;pkg_name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_build_script-kwargs</a-s><a-p>&quot;&gt;kwargs&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>Compile and execute a rust build script to generate build attributes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>This rules take the same arguments as rust_binary.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>Example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>Suppose you have a crate with a cargo build script `build.rs`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>```</a-p><a-tl>output</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>[workspace]/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>    hello_lib/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>        BUILD</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>        build.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>        src/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>            lib.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>Then you want to use the build script in the following:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>`hello_lib/BUILD`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>package(</a-p><a-v>default_visibility</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;//visibility:public&quot;</a-s><a-p>])</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_binary&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_library&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//cargo:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;cargo_build_script&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p># This will run the build script from the root of the workspace, and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p># collect the outputs.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>cargo_build_script(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;build_script&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;build.rs&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>    </a-p><a-c># Optional environment variables passed during build.rs compilation</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>    </a-p><a-v>rustc_env</a-v><a-p> </a-p><a-o>=</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>       </a-p><a-s>&quot;CARGO_PKG_VERSION&quot;</a-s><a-p>: </a-p><a-s>&quot;0.1.2&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>    },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>    </a-p><a-c># Optional environment variables passed during build.rs execution.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>    </a-p><a-c># Note that as the build script&#39;s working directory is not execroot,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>    </a-p><a-c># execpath/location will return an absolute path, instead of a relative</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>    </a-p><a-c># one.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>    </a-p><a-v>build_script_env</a-v><a-p> </a-p><a-o>=</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>        </a-p><a-s>&quot;SOME_TOOL_OR_FILE&quot;</a-s><a-p>: </a-p><a-s>&quot;$(execpath @tool//:binary)&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>    },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>    </a-p><a-c># Optional data/tool dependencies</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>    </a-p><a-v>data</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;@tool//:binary&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>rust_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;hello_lib&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>        </a-p><a-s>&quot;src/lib.rs&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>    ],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>    </a-p><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;:build_script&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>The `hello_lib` target will be build with the flags and the environment variables declared by the     build script in addition to the file generated by it.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>**PARAMETERS**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>| Name  | Description | Default Value |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-name&quot;&gt;&lt;/a&gt;name |  The name for the underlying rule. This should be the name of the package being compiled, optionally with a suffix of `_bs`. Otherwise, you can set the package name via `pkg_name`.   |  none |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-edition&quot;&gt;&lt;/a&gt;edition |  The rust edition to use for the internal binary crate.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-crate_name&quot;&gt;&lt;/a&gt;crate_name |  Crate name to use for build script.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-crate_root&quot;&gt;&lt;/a&gt;crate_root |  The file that will be passed to rustc to be used for building this crate.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-srcs&quot;&gt;&lt;/a&gt;srcs |  Souce files of the crate to build. Passing source files here can be used to trigger rebuilds when changes are made.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-crate_features&quot;&gt;&lt;/a&gt;crate_features |  A list of features to enable for the build script.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-version&quot;&gt;&lt;/a&gt;version |  The semantic version (semver) of the crate.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-deps&quot;&gt;&lt;/a&gt;deps |  The build-dependencies of the crate.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-link_deps&quot;&gt;&lt;/a&gt;link_deps |  The subset of the (normal) dependencies of the crate that have the links attribute and therefore provide environment variables to this build script.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-proc_macro_deps&quot;&gt;&lt;/a&gt;proc_macro_deps |  List of rust_proc_macro targets used to build the script.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-build_script_env&quot;&gt;&lt;/a&gt;build_script_env |  Environment variables for build scripts.   |  `{}` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-data&quot;&gt;&lt;/a&gt;data |  Files needed by the build script.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-compile_data&quot;&gt;&lt;/a&gt;compile_data |  Files needed for the compilation of the build script.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-tools&quot;&gt;&lt;/a&gt;tools |  Tools (executables) needed by the build script.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-links&quot;&gt;&lt;/a&gt;links |  Name of the native library this crate links against.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-rundir&quot;&gt;&lt;/a&gt;rundir |  A directory to `cd` to before the cargo_build_script is run. This should be a path relative to the exec root.&lt;br&gt;&lt;br&gt;The default behaviour (and the behaviour if rundir is set to the empty string) is to change to the relative path corresponding to the cargo manifest directory, which replicates the normal behaviour of cargo so it is easy to write compatible build scripts.&lt;br&gt;&lt;br&gt;If set to `.`, the cargo build script will run in the exec root.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-rustc_env&quot;&gt;&lt;/a&gt;rustc_env |  Environment variables to set in rustc when compiling the build script.   |  `{}` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-rustc_env_files&quot;&gt;&lt;/a&gt;rustc_env_files |  Files containing additional environment variables to set for rustc when building the build script.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-rustc_flags&quot;&gt;&lt;/a&gt;rustc_flags |  List of compiler flags passed to `rustc`.   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-visibility&quot;&gt;&lt;/a&gt;visibility |  Visibility to apply to the generated build script output.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-tags&quot;&gt;&lt;/a&gt;tags |  (list of str, optional): Tags to apply to the generated build script output.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-aliases&quot;&gt;&lt;/a&gt;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.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-pkg_name&quot;&gt;&lt;/a&gt;pkg_name |  Override the package name used for the build script. This is useful if the build target name gets too long otherwise.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_build_script-kwargs&quot;&gt;&lt;/a&gt;kwargs |  Forwards to the underlying `rust_binary` rule. An exception is the `compatible_with` attribute, which shouldn&#39;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 |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>&lt;a id=&quot;cargo_env&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>## </a-p><a-tt>cargo_env</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>cargo_env(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_env-env</a-s><a-p>&quot;&gt;env&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>A helper for generating platform specific environment variables</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_common&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//cargo:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;cargo_bootstrap_repository&quot;</a-s><a-p>, </a-p><a-s>&quot;cargo_env&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"><a-p>cargo_bootstrap_repository(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;bootstrapped_bin&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p>    </a-p><a-v>cargo_lockfile</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//:Cargo.lock&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>    </a-p><a-v>cargo_toml</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//:Cargo.toml&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;//:resolver_srcs&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"><a-p>    </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-v>rust_common</a-v><a-p>.</a-p><a-pr>default_version</a-pr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"><a-p>    </a-p><a-v>binary</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;my-crate-binary&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>    </a-p><a-v>env</a-v><a-p> </a-p><a-o>=</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p>        </a-p><a-s>&quot;x86_64-unknown-linux-gnu&quot;</a-s><a-p>: </a-p><a-f>cargo_env</a-f><a-p>({</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>            </a-p><a-s>&quot;FOO&quot;</a-s><a-p>: </a-p><a-s>&quot;BAR&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>        }),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>    },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"><a-p>    </a-p><a-v>env_label</a-v><a-p> </a-p><a-o>=</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>        </a-p><a-s>&quot;aarch64-unknown-linux-musl&quot;</a-s><a-p>: </a-p><a-f>cargo_env</a-f><a-p>({</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"><a-p>            </a-p><a-s>&quot;DOC&quot;</a-s><a-p>: </a-p><a-s>&quot;//:README.md&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>        }),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p>    }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>**PARAMETERS**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p>| Name  | Description | Default Value |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>| &lt;a id=&quot;cargo_env-env&quot;&gt;&lt;/a&gt;env |  A map of environment variables   |  none |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>**RETURNS**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>str: A json encoded string of the environment variables</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>&lt;a id=&quot;cargo_bootstrap_repository&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p>## </a-p><a-tt>cargo_bootstrap_repository</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>cargo_bootstrap_repository(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-srcs</a-s><a-p>&quot;&gt;srcs&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-binary</a-s><a-p>&quot;&gt;binary&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-build_mode</a-s><a-p>&quot;&gt;build_mode&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-cargo_config</a-s><a-p>&quot;&gt;cargo_config&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-cargo_lockfile</a-s><a-p>&quot;&gt;cargo_lockfile&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-cargo_toml</a-s><a-p>&quot;&gt;cargo_toml&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"><a-p>                           &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-compressed_windows_toolchain_names</a-s><a-p>&quot;&gt;compressed_windows_toolchain_names&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-env</a-s><a-p>&quot;&gt;env&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-env_label</a-s><a-p>&quot;&gt;env_label&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-repo_mapping</a-s><a-p>&quot;&gt;repo_mapping&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>                           &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-rust_toolchain_cargo_template</a-s><a-p>&quot;&gt;rust_toolchain_cargo_template&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-rust_toolchain_rustc_template</a-s><a-p>&quot;&gt;rust_toolchain_rustc_template&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-timeout</a-s><a-p>&quot;&gt;timeout&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"><a-p>                           &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#cargo_bootstrap_repository-version</a-s><a-p>&quot;&gt;version&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text">A rule for bootstrapping a Rust binary using [Cargo](https://doc.rust-lang.org/cargo/)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text">**ATTRIBUTES**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text">| Name  | Description | Type | Mandatory | Default |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text">| :------------- | :------------- | :------------- | :------------- | :------------- |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-name&quot;&gt;&lt;/a&gt;name |  A unique name for this repository.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-srcs&quot;&gt;&lt;/a&gt;srcs |  Souce files of the crate to build. Passing source files here can be used to trigger rebuilds when changes are made   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | optional |  `[]`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-binary&quot;&gt;&lt;/a&gt;binary |  The binary to build (the `--bin` parameter for Cargo). If left empty, the repository name will be used.   | String | optional |  `&quot;&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-build_mode&quot;&gt;&lt;/a&gt;build_mode |  The build mode the binary should be built with   | String | optional |  `&quot;release&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-cargo_config&quot;&gt;&lt;/a&gt;cargo_config |  The path of the Cargo configuration (`Config.toml`) file.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-cargo_lockfile&quot;&gt;&lt;/a&gt;cargo_lockfile |  The lockfile of the crate_universe resolver   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-cargo_toml&quot;&gt;&lt;/a&gt;cargo_toml |  The path of the `Cargo.toml` file.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-compressed_windows_toolchain_names&quot;&gt;&lt;/a&gt;compressed_windows_toolchain_names |  Wether or not the toolchain names of windows toolchains are expected to be in a `compressed` format.   | Boolean | optional |  `True`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-env&quot;&gt;&lt;/a&gt;env |  A mapping of platform triple to a set of environment variables. See [cargo_env](#cargo_env) for usage details. Additionally, the platform triple `*` applies to all platforms.   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; String&lt;/a&gt; | optional |  `{}`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-env_label&quot;&gt;&lt;/a&gt;env_label |  A mapping of platform triple to a set of environment variables. This attribute differs from `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.   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; String&lt;/a&gt; | optional |  `{}`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-repo_mapping&quot;&gt;&lt;/a&gt;repo_mapping |  In `WORKSPACE` context only: a dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.&lt;br&gt;&lt;br&gt;For example, an entry `&quot;@foo&quot;: &quot;@bar&quot;` 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`).&lt;br&gt;&lt;br&gt;This attribute is _not_ supported in `MODULE.bazel` context (when invoking a repository rule inside a module extension&#39;s implementation function).   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; String&lt;/a&gt; | optional |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-rust_toolchain_cargo_template&quot;&gt;&lt;/a&gt;rust_toolchain_cargo_template |  The template to use for finding the host `cargo` binary. `{version}` (eg. &#39;1.53.0&#39;), `{triple}` (eg. &#39;x86_64-unknown-linux-gnu&#39;), `{arch}` (eg. &#39;aarch64&#39;), `{vendor}` (eg. &#39;unknown&#39;), `{system}` (eg. &#39;darwin&#39;), `{channel}` (eg. &#39;stable&#39;), and `{tool}` (eg. &#39;rustc.exe&#39;) will be replaced in the string if present.   | String | optional |  `&quot;@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-rust_toolchain_rustc_template&quot;&gt;&lt;/a&gt;rust_toolchain_rustc_template |  The template to use for finding the host `rustc` binary. `{version}` (eg. &#39;1.53.0&#39;), `{triple}` (eg. &#39;x86_64-unknown-linux-gnu&#39;), `{arch}` (eg. &#39;aarch64&#39;), `{vendor}` (eg. &#39;unknown&#39;), `{system}` (eg. &#39;darwin&#39;), `{channel}` (eg. &#39;stable&#39;), and `{tool}` (eg. &#39;rustc.exe&#39;) will be replaced in the string if present.   | String | optional |  `&quot;@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-timeout&quot;&gt;&lt;/a&gt;timeout |  Maximum duration of the Cargo build command in seconds   | Integer | optional |  `600`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text">| &lt;a id=&quot;cargo_bootstrap_repository-version&quot;&gt;&lt;/a&gt;version |  The version of Rust the currently registered toolchain is using. Eg. `1.56.0`, or `nightly/2021-09-08`   | String | optional |  `&quot;1.83.0&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
