<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/crate_universe.md - fork/rules_rust @ cleanup</title>
<meta name="description" content="docs/src/crate_universe.md in fork/rules_rust at cleanup.">
<meta property="og:title" content="docs/src/crate_universe.md - fork/rules_rust @ cleanup">
<meta property="og:description" content="docs/src/crate_universe.md in fork/rules_rust at cleanup.">
<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="cleanup" data-tip="a4c87621ebc87a3e20fc4a1cdb273945ddb5ac86">
<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">Julia Ryan</span><span class="commit-message" data-commit="b5185cda784ff7ddaa0fc80821f1d757ba1d1d7a">Add patching docs</span><span class="snapshot-sha sha" data-commit="b5185cda784ff7ddaa0fc80821f1d757ba1d1d7a">b5185cda</span><time datetime="2024-12-04T11:18:17-08:00" title="2024-12-04 11:18:17 -0800">2024-12-04</time></p>
<header class="topbar"><details class="switcher"><summary>cleanup</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a 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/cleanup/tree/docs/">docs</a> / <a href="/fork/rules_rust/ref/cleanup/tree/docs/src/">src</a> / <span class="cur">crate_universe.md</span></nav>
<span class="view-stats"><span>56.1 KiB</span><span>913 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/a6da86e7782e0ec0e49bc75ac1a4ac60fa12343d/docs/src/crate_universe.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>Crate Universe</h1>
<p>Crate Universe is a set of Bazel rule for generating Rust targets using Cargo.</p>
<p>This doc describes using crate_universe from a WORKSPACE file.</p>
<p>If you're using bzlmod, please see <a href="crate_universe_bzlmod.html">the bzlmod equivalent of this doc</a>.</p>
<h2>Setup</h2>
<p>After loading <code>rules_rust</code> in your workspace, set the following to begin using <code>crate_universe</code>:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//crate_universe:repositories.bzl&quot;</a-s>, <a-s>&quot;crate_universe_dependencies&quot;</a-s>)

<a-f>crate_universe_dependencies</a-f>()</pre>
<p>Note that if the current version of <code>rules_rust</code> is not a release artifact, you may need to set additional
flags such as <a href="#crate_universe_dependencies-bootstrap"><code>bootstrap = True</code></a> on the <code>crate_universe_dependencies</code>
call above or <a href="#crates_repository-generator_urls">crates_repository::generator_urls</a> in uses of <code>crates_repository</code>.</p>
<h2>Rules</h2>
<ul>
<li><a href="#crates_repository">crates_repository</a></li>
<li><a href="#crates_vendor">crates_vendor</a></li>
</ul>
<h2>Utility Macros</h2>
<ul>
<li><a href="#crate_universe_dependencies">crate_universe_dependencies</a></li>
<li><a href="#crateannotation">crate.annotation</a></li>
<li><a href="#crateselect">crate.select</a></li>
<li><a href="#cratespec">crate.spec</a></li>
<li><a href="#crateworkspace_member">crate.workspace_member</a></li>
<li><a href="#render_config">render_config</a></li>
<li><a href="#splicing_config">splicing_config</a></li>
</ul>
<h2>Workflows</h2>
<p>The <a href="#crates_repository"><code>crates_repository</code></a> rule (the primary repository rule of <code>rules_rust</code>'s cargo support) supports a number of different
ways users can express and organize their dependencies. The most common are listed below though there are more to be found in
the <a href="https://github.com/bazelbuild/rules_rust/tree/main/examples/crate_universe">./examples/crate_universe</a> directory.</p>
<h3>Cargo Workspaces</h3>
<p>One of the simpler ways to wire up dependencies would be to first structure your project into a <a href="https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html">Cargo workspace</a>.
The <code>crates_repository</code> rule can ingest a root <code>Cargo.toml</code> file and generate dependencies from there.</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s>, <a-s>&quot;crates_repository&quot;</a-s>)

<a-f>crates_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;crate_index&quot;</a-s>,
    <a-v>cargo_lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.lock&quot;</a-s>,
    <a-v>lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.Bazel.lock&quot;</a-s>,
    <a-v>manifests</a-v> <a-o>=</a-o> [<a-s>&quot;//:Cargo.toml&quot;</a-s>],
)

<a-f>load</a-f>(<a-s>&quot;@crate_index//:defs.bzl&quot;</a-s>, <a-s>&quot;crate_repositories&quot;</a-s>)

<a-f>crate_repositories</a-f>()</pre>
<p>The generated <code>crates_repository</code> contains helper macros which make collecting dependencies for Bazel targets simpler.
Notably, the <code>all_crate_deps</code> and <code>aliases</code> macros (see <a href="#dependencies-api">Dependencies API</a>) commonly allow the
<code>Cargo.toml</code> files to be the single source of truth for dependencies. Since these macros come from the generated
repository, the dependencies and alias definitions they return will automatically update BUILD targets.</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@crate_index//:defs.bzl&quot;</a-s>, <a-s>&quot;aliases&quot;</a-s>, <a-s>&quot;all_crate_deps&quot;</a-s>)
<a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s>, <a-s>&quot;rust_library&quot;</a-s>, <a-s>&quot;rust_test&quot;</a-s>)

<a-f>rust_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;lib&quot;</a-s>,
    <a-v>aliases</a-v> <a-o>=</a-o> <a-f>aliases</a-f>(),
    <a-v>deps</a-v> <a-o>=</a-o> <a-f>all_crate_deps</a-f>(
        <a-v>normal</a-v> <a-o>=</a-o> <a-co>True</a-co>,
    ),
    <a-v>proc_macro_deps</a-v> <a-o>=</a-o> <a-f>all_crate_deps</a-f>(
        <a-v>proc_macro</a-v> <a-o>=</a-o> <a-co>True</a-co>,
    ),
)

<a-f>rust_test</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;unit_test&quot;</a-s>,
    <a-v>crate</a-v> <a-o>=</a-o> <a-s>&quot;:lib&quot;</a-s>,
    <a-v>aliases</a-v> <a-o>=</a-o> <a-f>aliases</a-f>(
        <a-v>normal_dev</a-v> <a-o>=</a-o> <a-co>True</a-co>,
        <a-v>proc_macro_dev</a-v> <a-o>=</a-o> <a-co>True</a-co>,
    ),
    <a-v>deps</a-v> <a-o>=</a-o> <a-f>all_crate_deps</a-f>(
        <a-v>normal_dev</a-v> <a-o>=</a-o> <a-co>True</a-co>,
    ),
    <a-v>proc_macro_deps</a-v> <a-o>=</a-o> <a-f>all_crate_deps</a-f>(
        <a-v>proc_macro_dev</a-v> <a-o>=</a-o> <a-co>True</a-co>,
    ),
)</pre>
<h3>Direct Packages</h3>
<p>In cases where Rust targets have heavy interractions with other Bazel targests (<a href="https://docs.bazel.build/versions/main/be/c-cpp.html">Cc</a>, <a href="https://rules-proto-grpc.com/en/latest/lang/rust.html">Proto</a>, etc.),
maintaining <code>Cargo.toml</code> files may have deminishing returns as things like <a href="https://rust-analyzer.github.io/">rust-analyzer</a> begin to be confused
about missing targets or environment variables defined only in Bazel. In workspaces like this, it may be desirable
to have a "Cargo free" setup. <code>crates_repository</code> supports this through the <code>packages</code> attribute.</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s>, <a-s>&quot;crate&quot;</a-s>, <a-s>&quot;crates_repository&quot;</a-s>, <a-s>&quot;render_config&quot;</a-s>)

<a-f>crates_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;crate_index&quot;</a-s>,
    <a-v>cargo_lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.lock&quot;</a-s>,
    <a-v>lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.Bazel.lock&quot;</a-s>,
    <a-v>packages</a-v> <a-o>=</a-o> {
        <a-s>&quot;async-trait&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0.1.51&quot;</a-s>,
        ),
        <a-s>&quot;mockall&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0.10.2&quot;</a-s>,
        ),
        <a-s>&quot;tokio&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;1.12.0&quot;</a-s>,
        ),
    },
    <a-c># Setting the default package name to `&quot;&quot;` forces the use of the macros defined in this repository</a-c>
    <a-c># to always use the root package when looking for dependencies or aliases. This should be considered</a-c>
    <a-c># optional as the repository also exposes alises for easy access to all dependencies.</a-c>
    <a-v>render_config</a-v> <a-o>=</a-o> <a-f>render_config</a-f>(
        <a-v>default_package_name</a-v> <a-o>=</a-o> <a-s>&quot;&quot;</a-s>
    ),
)

<a-f>load</a-f>(<a-s>&quot;@crate_index//:defs.bzl&quot;</a-s>, <a-s>&quot;crate_repositories&quot;</a-s>)

<a-f>crate_repositories</a-f>()</pre>
<p>Consuming dependencies may be more ergonomic in this case through the aliases defined in the new repository.</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_library&quot;</a-s>, <a-s>&quot;rust_test&quot;</a-s>)

<a-f>rust_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;lib&quot;</a-s>,
    <a-v>deps</a-v> <a-o>=</a-o> [
        <a-s>&quot;@crate_index//:tokio&quot;</a-s>,
    ],
    <a-v>proc_macro_deps</a-v> <a-o>=</a-o> [
        <a-s>&quot;@crate_index//:async-trait&quot;</a-s>,
    ],
)

<a-f>rust_test</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;unit_test&quot;</a-s>,
    <a-v>crate</a-v> <a-o>=</a-o> <a-s>&quot;:lib&quot;</a-s>,
    <a-v>deps</a-v> <a-o>=</a-o> [
        <a-s>&quot;@crate_index//:mockall&quot;</a-s>,
    ],
)</pre>
<h3>Binary dependencies</h3>
<p>Neither of the above approaches supports depending on binary-only packages.</p>
<p>In order to depend on a Cargo package that contains binaries and no library, you
will need to do one of the following:</p>
<ul>
<li>
<p>Fork the package to add an empty lib.rs, which makes the package visible to
Cargo metadata and compatible with the above approaches;</p>
</li>
<li>
<p>Or handwrite your own build target for the binary, use <code>http_archive</code> to
import its source code, and use <code>crates_repository</code> to make build targets for
its dependencies. This is demonstrated below using the <code>rustfilt</code> crate as an
example.</p>
</li>
</ul>
<pre class="language-python"><a-c># in WORKSPACE.bazel</a-c>

<a-f>load</a-f>(<a-s>&quot;@bazel_tools//tools/build_defs/repo:http.bzl&quot;</a-s>, <a-s>&quot;http_archive&quot;</a-s>)

<a-f>http_archive</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rustfilt&quot;</a-s>,
    <a-v>build_file</a-v> <a-o>=</a-o> <a-s>&quot;//rustfilt:BUILD.rustfilt.bazel&quot;</a-s>,
    <a-v>sha256</a-v> <a-o>=</a-o> <a-s>&quot;c8d748b182c8f95224336d20dcc5609598af612581ce60cfb29da4dc8d0091f2&quot;</a-s>,
    <a-v>strip_prefix</a-v> <a-o>=</a-o> <a-s>&quot;rustfilt-0.2.1&quot;</a-s>,
    <a-v>type</a-v> <a-o>=</a-o> <a-s>&quot;tar.gz&quot;</a-s>,
    <a-v>urls</a-v> <a-o>=</a-o> [<a-s>&quot;https://static.crates.io/crates/rustfilt/rustfilt-0.2.1.crate&quot;</a-s>],
)

<a-f>load</a-f>(<a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s>, <a-s>&quot;crates_repository&quot;</a-s>)

<a-f>crates_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rustfilt_deps&quot;</a-s>,
    <a-v>cargo_lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//rustfilt:Cargo.lock&quot;</a-s>,
    <a-v>manifests</a-v> <a-o>=</a-o> [<a-s>&quot;@rustfilt//:Cargo.toml&quot;</a-s>],
)

<a-f>load</a-f>(<a-s>&quot;@rustfilt_deps//:defs.bzl&quot;</a-s>, <a-v>rustfilt_deps</a-v> <a-o>=</a-o> <a-s>&quot;crate_repositories&quot;</a-s>)

<a-f>rustfilt_deps</a-f>()</pre>
<pre class="language-python"><a-c># in rustfilt/BUILD.rustfilt.bazel</a-c>

<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-f>rust_binary</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rustfilt&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> <a-f>glob</a-f>([<a-s>&quot;src/**/*.rs&quot;</a-s>]),
    <a-v>edition</a-v> <a-o>=</a-o> <a-s>&quot;2018&quot;</a-s>,
    <a-v>deps</a-v> <a-o>=</a-o> [
        <a-s>&quot;@rustfilt_deps//:clap&quot;</a-s>,
        <a-s>&quot;@rustfilt_deps//:lazy_static&quot;</a-s>,
        <a-s>&quot;@rustfilt_deps//:regex&quot;</a-s>,
        <a-s>&quot;@rustfilt_deps//:rustc-demangle&quot;</a-s>,
    ],
)</pre>
<p>If you use either <code>crates_repository</code> or <code>crates_vendor</code> to depend on a Cargo
package that contains <em>both</em> a library crate <em>and</em> binaries, by default only the
library gets made available to Bazel. To generate Bazel targets for the binary
crates as well, you must opt in to it with an annotation on the package:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s>, <a-s>&quot;crates_repository&quot;</a-s>, <a-s>&quot;crate&quot;</a-s>)

<a-f>crates_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;crate_index&quot;</a-s>,
    <a-v>annotations</a-v> <a-o>=</a-o> {
        <a-s>&quot;thepackage&quot;</a-s>: [<a-v>crate</a-v>.<a-pr>annotation</a-pr>(
            <a-v>gen_binaries</a-v> <a-o>=</a-o> <a-co>True</a-co>,
            <a-c># Or, to expose just a subset of the package&#39;s binaries by name:</a-c>
            <a-v>gen_binaries</a-v> <a-o>=</a-o> [<a-s>&quot;rustfilt&quot;</a-s>],
        )],
    },
    <a-c># Or, to expose every binary of every package:</a-c>
    <a-v>generate_binaries</a-v> <a-o>=</a-o> <a-co>True</a-co>,
    ...
)</pre>
<h2>Dependencies API</h2>
<p>After rendering dependencies, convenience macros may also be generated to provide
convenient accessors to larger sections of the dependency graph.</p>
<ul>
<li><a href="#aliases">aliases</a></li>
<li><a href="#crate_deps">crate_deps</a></li>
<li><a href="#all_crate_deps">all_crate_deps</a></li>
<li><a href="#crate_repositories">crate_repositories</a></li>
</ul>
<h2>Building crates with complicated dependencies</h2>
<p>Some crates have build.rs scripts which are complicated to run. Typically these build C++ (or other languages), or attempt to find pre-installed libraries on the build machine.</p>
<p>There are a few approaches to making sure these run:</p>
<h3>Some things work without intervention</h3>
<p>Some build scripts will happily run without any support needed.</p>
<p>rules_rust already supplies a configured C++ toolchain as input to build script execution, and sets variables like <code>CC</code>, <code>CXX</code>, <code>LD</code>, <code>LDFLAGS</code>, etc as needed. Many crates which invoke a compiler with the default environment, or forward these env vars, will Just Work (e.g. if using <a href="https://github.com/rust-lang/cc-rs"><code>cc-rs</code></a>).</p>
<p>rules_rust is open to PRs which make build scripts more likely to work by default with intervention assuming they're broadly applicable (e.g. setting extra widely-known env vars is probably fine, wiring up additional toolchains like <code>cmake</code> that aren't present by default for most Bazel users probably isn't).</p>
<h3>Supplying extra tools to build</h3>
<p>Some build scripts can be made to work by pulling in some extra files and making them available to the build script.</p>
<p>Commonly this is done by passing the file to the <code>build_script_data</code> annotation for the crate, and using <code>build_script_env</code> to tell the build script where the file is. That env var may often use <code>$(execroot)</code> to get the path to the label, or <code>$${pwd}/</code> as a prefix if the path given is relative to the execroot (as will frequently happen when using a toolchain).A</p>
<p>There is an example of this in the "complicated dependencies" section of https://github.com/bazelbuild/rules_rust/blob/main/examples/crate_universe/WORKSPACE.bazel which builds libz-ng-sys.</p>
<h3>Building with Bazel and supplying via an override</h3>
<p>Some build scripts have hooks to allow replacing parts that are complicated to build with output prepared by Bazel.</p>
<p>We can use those hooks by specifying paths (generally using the <code>build_script_data</code> and <code>build_script_env</code> annotations) and pointing them at labels which Bazel will then build. These env vars may often use <code>$(execroot)</code> to get the path to the label, or <code>$${pwd}/</code> as a prefix if the path given is relative to the execroot (as will frequently happen when using a toolchain).</p>
<p>There is an example of this in the "complicated dependencies" section of https://github.com/bazelbuild/rules_rust/blob/main/examples/crate_universe/WORKSPACE.bazel which builds boring-sys.</p>
<hr />
<hr />
<p>&lt;a id="crates_vendor"&gt;&lt;/a&gt;</p>
<h2>crates_vendor</h2>
&lt;pre&gt;
crates_vendor(&lt;a href="#crates_vendor-name"&gt;name&lt;/a&gt;, &lt;a href="#crates_vendor-annotations"&gt;annotations&lt;/a&gt;, &lt;a href="#crates_vendor-bazel"&gt;bazel&lt;/a&gt;, &lt;a href="#crates_vendor-buildifier"&gt;buildifier&lt;/a&gt;, &lt;a href="#crates_vendor-cargo_bazel"&gt;cargo_bazel&lt;/a&gt;, &lt;a href="#crates_vendor-cargo_config"&gt;cargo_config&lt;/a&gt;, &lt;a href="#crates_vendor-cargo_lockfile"&gt;cargo_lockfile&lt;/a&gt;,
              &lt;a href="#crates_vendor-generate_binaries"&gt;generate_binaries&lt;/a&gt;, &lt;a href="#crates_vendor-generate_build_scripts"&gt;generate_build_scripts&lt;/a&gt;, &lt;a href="#crates_vendor-generate_target_compatible_with"&gt;generate_target_compatible_with&lt;/a&gt;, &lt;a href="#crates_vendor-manifests"&gt;manifests&lt;/a&gt;,
              &lt;a href="#crates_vendor-mode"&gt;mode&lt;/a&gt;, &lt;a href="#crates_vendor-packages"&gt;packages&lt;/a&gt;, &lt;a href="#crates_vendor-render_config"&gt;render_config&lt;/a&gt;, &lt;a href="#crates_vendor-repository_name"&gt;repository_name&lt;/a&gt;, &lt;a href="#crates_vendor-splicing_config"&gt;splicing_config&lt;/a&gt;,
              &lt;a href="#crates_vendor-supported_platform_triples"&gt;supported_platform_triples&lt;/a&gt;, &lt;a href="#crates_vendor-vendor_path"&gt;vendor_path&lt;/a&gt;)
&lt;/pre&gt;
<p>A rule for defining Rust dependencies (crates) and writing targets for them to the current workspace.
This rule is useful for users whose workspaces are expected to be consumed in other workspaces as the
rendered <code>BUILD</code> files reduce the number of workspace dependencies, allowing for easier loads. This rule
handles all the same <a href="#workflows">workflows</a> <code>crate_universe</code> rules do.</p>
<p>Example:</p>
<p>Given the following workspace structure:</p>
<pre>[workspace]/
    WORKSPACE
    BUILD
    Cargo.toml
    3rdparty/
        BUILD
    src/
        main.rs
</pre>
<p>The following is something that'd be found in <code>3rdparty/BUILD</code>:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s>, <a-s>&quot;crates_vendor&quot;</a-s>, <a-s>&quot;crate&quot;</a-s>)

<a-f>crates_vendor</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;crates_vendor&quot;</a-s>,
    <a-v>annotations</a-v> <a-o>=</a-o> {
        <a-s>&quot;rand&quot;</a-s>: [<a-v>crate</a-v>.<a-pr>annotation</a-pr>(
            <a-v>default_features</a-v> <a-o>=</a-o> <a-co>False</a-co>,
            <a-v>features</a-v> <a-o>=</a-o> [<a-s>&quot;small_rng&quot;</a-s>],
        )],
    },
    <a-v>cargo_lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.Bazel.lock&quot;</a-s>,
    <a-v>manifests</a-v> <a-o>=</a-o> [<a-s>&quot;//:Cargo.toml&quot;</a-s>],
    <a-v>mode</a-v> <a-o>=</a-o> <a-s>&quot;remote&quot;</a-s>,
    <a-v>vendor_path</a-v> <a-o>=</a-o> <a-s>&quot;crates&quot;</a-s>,
    <a-v>tags</a-v> <a-o>=</a-o> [<a-s>&quot;manual&quot;</a-s>],
)</pre>
<p>The above creates a target that can be run to write <code>BUILD</code> files into the <code>3rdparty</code>
directory next to where the target is defined. To run it, simply call:</p>
<pre class="language-bash"><a-f>bazel</a-f> run //3rdparty:crates_vendor</pre>
<h3>Patching</h3>
<p>If you need to replace crates in your third_party dependency tree with forks, the <code>patch</code> section can be used in your cargo manifest:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>patch</a-pr><a-p>.</a-p><a-pr>crates-io</a-pr><a-p>]</a-p>
<a-pr>fuse3</a-pr> <a-o>=</a-o> <a-p>{</a-p> <a-pr>path</a-pr> <a-o>=</a-o> <a-s>&quot;forks/fuse3&quot;</a-s> <a-p>}</a-p></pre>
<p>A build file for the patched crate will still be generated under the vendor path
(such as <code>crates/fuse3-0.6.1/BUILD.bazel</code>), but <code>cargo vendor</code> will NOT download the
crate to that location, and the generated BUILD file will point to your copy. For this
to work, you need to define the following filegroups in your patch crate's BUILD.bazel:
<code>:srcs</code>, <code>:crate_root</code>, <code>:compile_data</code>, and (if the crate has a build script)
<code>:build_script_crate_root</code>. See the
<a href="https://github.com/bazelbuild/rules_rust/tree/main/examples/crate_universe/vendor_local_patching">patching example</a>
for an example of what those BUILD files look like.</p>
<p>This feature can also be used to avoid vendoring source code for crates that you never
actually use for the platforms you're targeting. In that case you don't need an extra
BUILD file, just crate a empty/stub Cargo.toml and <code>lib.rs</code>, and list the path to that
in your <code>patch</code> section.</p>
<p>&lt;a id="#crates_vendor_repinning_updating_dependencies"&gt;&lt;/a&gt;</p>
<h3>Repinning / Updating Dependencies</h3>
<p>Repinning dependencies is controlled by both the <code>CARGO_BAZEL_REPIN</code> environment variable or the <code>--repin</code>
flag to the <code>crates_vendor</code> binary. To update dependencies, simply add the flag to your <code>bazel run</code> invocation.</p>
<pre class="language-bash"><a-f>bazel</a-f> run //3rdparty:crates_vendor <a-co>--</a-co> <a-co>--repin</a-co></pre>
<p>Under the hood, <code>--repin</code> will trigger a <a href="https://doc.rust-lang.org/cargo/commands/cargo-update.html">cargo update</a>
call against the generated workspace. The following table describes how to control particular values passed to the
<code>cargo update</code> command.</p>
<table><thead><tr><th>Value</th><th>Cargo command</th></tr></thead><tbody>
<tr><td>Any of [<code>true</code>, <code>1</code>, <code>yes</code>, <code>on</code>, <code>workspace</code>]</td><td><code>cargo update --workspace</code></td></tr>
<tr><td>Any of [<code>full</code>, <code>eager</code>, <code>all</code>]</td><td><code>cargo update</code></td></tr>
<tr><td><code>package_name</code></td><td><code>cargo upgrade --package package_name</code></td></tr>
<tr><td><code>package_name@1.2.3</code></td><td><code>cargo upgrade --package package_name --precise 1.2.3</code></td></tr>
</tbody></table>
<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="crates_vendor-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="crates_vendor-annotations"&gt;&lt;/a&gt;annotations</td><td style="text-align: left">Extra settings to apply to crates. See <a href="#crateannotation">crate.annotation</a>.</td><td style="text-align: left">&lt;a href="https://bazel.build/rules/lib/dict"&gt;Dictionary: String -&gt; List of strings&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="crates_vendor-bazel"&gt;&lt;/a&gt;bazel</td><td style="text-align: left">The path to a bazel binary used to locate the output_base for the current workspace.</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="crates_vendor-buildifier"&gt;&lt;/a&gt;buildifier</td><td style="text-align: left">The path to a <a href="https://github.com/bazelbuild/buildtools/blob/5.0.1/buildifier/README.md">buildifier</a> binary used to format generated BUILD files.</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>"@rules_rust//crate_universe/private/vendor:buildifier"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crates_vendor-cargo_bazel"&gt;&lt;/a&gt;cargo_bazel</td><td style="text-align: left">The cargo-bazel binary to use for vendoring. If this attribute is not set, then a <code>CARGO_BAZEL_GENERATOR_PATH</code> action env will be used.</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>"@@rules_rust~~cargo_bazel_bootstrap~cargo_bazel_bootstrap//:binary"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crates_vendor-cargo_config"&gt;&lt;/a&gt;cargo_config</td><td style="text-align: left">A <a href="https://doc.rust-lang.org/cargo/reference/config.html">Cargo configuration</a> 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="crates_vendor-cargo_lockfile"&gt;&lt;/a&gt;cargo_lockfile</td><td style="text-align: left">The path to an existing <code>Cargo.lock</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="crates_vendor-generate_binaries"&gt;&lt;/a&gt;generate_binaries</td><td style="text-align: left">Whether to generate <code>rust_binary</code> targets for all the binary crates in every package. By default only the <code>rust_library</code> targets are generated.</td><td style="text-align: left">Boolean</td><td style="text-align: left">optional</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crates_vendor-generate_build_scripts"&gt;&lt;/a&gt;generate_build_scripts</td><td style="text-align: left">Whether or not to generate <a href="https://doc.rust-lang.org/cargo/reference/build-scripts.html">cargo build scripts</a> by default.</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="crates_vendor-generate_target_compatible_with"&gt;&lt;/a&gt;generate_target_compatible_with</td><td style="text-align: left">DEPRECATED: Moved to <code>render_config</code>.</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="crates_vendor-manifests"&gt;&lt;/a&gt;manifests</td><td style="text-align: left">A list of Cargo manifests (<code>Cargo.toml</code> files).</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="crates_vendor-mode"&gt;&lt;/a&gt;mode</td><td style="text-align: left">Flags determining how crates should be vendored. <code>local</code> is where crate source and BUILD files are written to the repository. <code>remote</code> is where only BUILD files are written and repository rules used to fetch source code.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"remote"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crates_vendor-packages"&gt;&lt;/a&gt;packages</td><td style="text-align: left">A set of crates (packages) specifications to depend on. See <a href="#crate.spec">crate.spec</a>.</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="crates_vendor-render_config"&gt;&lt;/a&gt;render_config</td><td style="text-align: left">The configuration flags to use for rendering. Use <code>//crate_universe:defs.bzl\%render_config</code> to generate the value for this field. If unset, the defaults defined there 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="crates_vendor-repository_name"&gt;&lt;/a&gt;repository_name</td><td style="text-align: left">The name of the repository to generate for <code>remote</code> vendor modes. If unset, the label 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="crates_vendor-splicing_config"&gt;&lt;/a&gt;splicing_config</td><td style="text-align: left">The configuration flags to use for splicing Cargo maniests. Use <code>//crate_universe:defs.bzl\%rsplicing_config</code> to generate the value for this field. If unset, the defaults defined there 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="crates_vendor-supported_platform_triples"&gt;&lt;/a&gt;supported_platform_triples</td><td style="text-align: left">A set of all platform triples to consider when generating dependencies.</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>["aarch64-apple-darwin", "aarch64-apple-ios", "aarch64-apple-ios-sim", "aarch64-linux-android", "aarch64-pc-windows-msvc", "aarch64-unknown-fuchsia", "aarch64-unknown-linux-gnu", "aarch64-unknown-nixos-gnu", "aarch64-unknown-nto-qnx710", "arm-unknown-linux-gnueabi", "armv7-linux-androideabi", "armv7-unknown-linux-gnueabi", "i686-apple-darwin", "i686-linux-android", "i686-pc-windows-msvc", "i686-unknown-freebsd", "i686-unknown-linux-gnu", "powerpc-unknown-linux-gnu", "riscv32imc-unknown-none-elf", "riscv64gc-unknown-none-elf", "s390x-unknown-linux-gnu", "thumbv7em-none-eabi", "thumbv8m.main-none-eabi", "wasm32-unknown-unknown", "wasm32-wasip1", "x86_64-apple-darwin", "x86_64-apple-ios", "x86_64-linux-android", "x86_64-pc-windows-msvc", "x86_64-unknown-freebsd", "x86_64-unknown-fuchsia", "x86_64-unknown-linux-gnu", "x86_64-unknown-nixos-gnu", "x86_64-unknown-none"]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crates_vendor-vendor_path"&gt;&lt;/a&gt;vendor_path</td><td style="text-align: left">The path to a directory to write files into. Absolute paths will be treated as relative to the workspace root</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"crates"</code></td></tr>
</tbody></table>
<p>&lt;a id="aliases"&gt;&lt;/a&gt;</p>
<h2>aliases</h2>
&lt;pre&gt;
aliases(&lt;a href="#aliases-normal"&gt;normal&lt;/a&gt;, &lt;a href="#aliases-normal_dev"&gt;normal_dev&lt;/a&gt;, &lt;a href="#aliases-proc_macro"&gt;proc_macro&lt;/a&gt;, &lt;a href="#aliases-proc_macro_dev"&gt;proc_macro_dev&lt;/a&gt;, &lt;a href="#aliases-build"&gt;build&lt;/a&gt;, &lt;a href="#aliases-build_proc_macro"&gt;build_proc_macro&lt;/a&gt;, &lt;a href="#aliases-package_name"&gt;package_name&lt;/a&gt;)
&lt;/pre&gt;
<p>Produces a map of Crate alias names to their original label</p>
<p>If no dependency kinds are specified, <code>normal</code> and <code>proc_macro</code> are used by default.
Setting any one flag will otherwise determine the contents of the returned dict.</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="aliases-normal"&gt;&lt;/a&gt;normal</td><td style="text-align: left">If True, normal dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="aliases-normal_dev"&gt;&lt;/a&gt;normal_dev</td><td style="text-align: left">If True, normal dev dependencies will be included in the output list..</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="aliases-proc_macro"&gt;&lt;/a&gt;proc_macro</td><td style="text-align: left">If True, proc_macro dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="aliases-proc_macro_dev"&gt;&lt;/a&gt;proc_macro_dev</td><td style="text-align: left">If True, dev proc_macro dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="aliases-build"&gt;&lt;/a&gt;build</td><td style="text-align: left">If True, build dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="aliases-build_proc_macro"&gt;&lt;/a&gt;build_proc_macro</td><td style="text-align: left">If True, build proc_macro dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="aliases-package_name"&gt;&lt;/a&gt;package_name</td><td style="text-align: left">The package name of the set of dependencies to look up. Defaults to <code>native.package_name()</code> when unset.</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>dict: The aliases of all associated packages</p>
<p>&lt;a id="all_crate_deps"&gt;&lt;/a&gt;</p>
<h2>all_crate_deps</h2>
&lt;pre&gt;
all_crate_deps(&lt;a href="#all_crate_deps-normal"&gt;normal&lt;/a&gt;, &lt;a href="#all_crate_deps-normal_dev"&gt;normal_dev&lt;/a&gt;, &lt;a href="#all_crate_deps-proc_macro"&gt;proc_macro&lt;/a&gt;, &lt;a href="#all_crate_deps-proc_macro_dev"&gt;proc_macro_dev&lt;/a&gt;, &lt;a href="#all_crate_deps-build"&gt;build&lt;/a&gt;, &lt;a href="#all_crate_deps-build_proc_macro"&gt;build_proc_macro&lt;/a&gt;,
               &lt;a href="#all_crate_deps-package_name"&gt;package_name&lt;/a&gt;)
&lt;/pre&gt;
<p>Finds the fully qualified label of all requested direct crate dependencies     for the package where this macro is called.</p>
<p>If no parameters are set, all normal dependencies are returned. Setting any one flag will
otherwise impact the contents of the returned list.</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="all_crate_deps-normal"&gt;&lt;/a&gt;normal</td><td style="text-align: left">If True, normal dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="all_crate_deps-normal_dev"&gt;&lt;/a&gt;normal_dev</td><td style="text-align: left">If True, normal dev dependencies will be included in the output list..</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="all_crate_deps-proc_macro"&gt;&lt;/a&gt;proc_macro</td><td style="text-align: left">If True, proc_macro dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="all_crate_deps-proc_macro_dev"&gt;&lt;/a&gt;proc_macro_dev</td><td style="text-align: left">If True, dev proc_macro dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="all_crate_deps-build"&gt;&lt;/a&gt;build</td><td style="text-align: left">If True, build dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="all_crate_deps-build_proc_macro"&gt;&lt;/a&gt;build_proc_macro</td><td style="text-align: left">If True, build proc_macro dependencies are included in the output list.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="all_crate_deps-package_name"&gt;&lt;/a&gt;package_name</td><td style="text-align: left">The package name of the set of dependencies to look up. Defaults to <code>native.package_name()</code> when unset.</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>list: A list of labels to generated rust targets (str)</p>
<p>&lt;a id="crate.annotation"&gt;&lt;/a&gt;</p>
<h2>crate.annotation</h2>
&lt;pre&gt;
crate.annotation(&lt;a href="#crate.annotation-version"&gt;version&lt;/a&gt;, &lt;a href="#crate.annotation-additive_build_file"&gt;additive_build_file&lt;/a&gt;, &lt;a href="#crate.annotation-additive_build_file_content"&gt;additive_build_file_content&lt;/a&gt;, &lt;a href="#crate.annotation-alias_rule"&gt;alias_rule&lt;/a&gt;,
                 &lt;a href="#crate.annotation-build_script_compile_data"&gt;build_script_compile_data&lt;/a&gt;, &lt;a href="#crate.annotation-build_script_data"&gt;build_script_data&lt;/a&gt;, &lt;a href="#crate.annotation-build_script_tools"&gt;build_script_tools&lt;/a&gt;,
                 &lt;a href="#crate.annotation-build_script_data_glob"&gt;build_script_data_glob&lt;/a&gt;, &lt;a href="#crate.annotation-build_script_deps"&gt;build_script_deps&lt;/a&gt;, &lt;a href="#crate.annotation-build_script_env"&gt;build_script_env&lt;/a&gt;,
                 &lt;a href="#crate.annotation-build_script_proc_macro_deps"&gt;build_script_proc_macro_deps&lt;/a&gt;, &lt;a href="#crate.annotation-build_script_rundir"&gt;build_script_rundir&lt;/a&gt;, &lt;a href="#crate.annotation-build_script_rustc_env"&gt;build_script_rustc_env&lt;/a&gt;,
                 &lt;a href="#crate.annotation-build_script_toolchains"&gt;build_script_toolchains&lt;/a&gt;, &lt;a href="#crate.annotation-compile_data"&gt;compile_data&lt;/a&gt;, &lt;a href="#crate.annotation-compile_data_glob"&gt;compile_data_glob&lt;/a&gt;, &lt;a href="#crate.annotation-crate_features"&gt;crate_features&lt;/a&gt;, &lt;a href="#crate.annotation-data"&gt;data&lt;/a&gt;,
                 &lt;a href="#crate.annotation-data_glob"&gt;data_glob&lt;/a&gt;, &lt;a href="#crate.annotation-deps"&gt;deps&lt;/a&gt;, &lt;a href="#crate.annotation-extra_aliased_targets"&gt;extra_aliased_targets&lt;/a&gt;, &lt;a href="#crate.annotation-gen_binaries"&gt;gen_binaries&lt;/a&gt;, &lt;a href="#crate.annotation-disable_pipelining"&gt;disable_pipelining&lt;/a&gt;,
                 &lt;a href="#crate.annotation-gen_build_script"&gt;gen_build_script&lt;/a&gt;, &lt;a href="#crate.annotation-patch_args"&gt;patch_args&lt;/a&gt;, &lt;a href="#crate.annotation-patch_tool"&gt;patch_tool&lt;/a&gt;, &lt;a href="#crate.annotation-patches"&gt;patches&lt;/a&gt;, &lt;a href="#crate.annotation-proc_macro_deps"&gt;proc_macro_deps&lt;/a&gt;, &lt;a href="#crate.annotation-rustc_env"&gt;rustc_env&lt;/a&gt;,
                 &lt;a href="#crate.annotation-rustc_env_files"&gt;rustc_env_files&lt;/a&gt;, &lt;a href="#crate.annotation-rustc_flags"&gt;rustc_flags&lt;/a&gt;, &lt;a href="#crate.annotation-shallow_since"&gt;shallow_since&lt;/a&gt;, &lt;a href="#crate.annotation-override_targets"&gt;override_targets&lt;/a&gt;)
&lt;/pre&gt;
<p>A collection of extra attributes and settings for a particular crate</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="crate.annotation-version"&gt;&lt;/a&gt;version</td><td style="text-align: left">The version or semver-conditions to match with a crate. The wildcard <code>*</code> matches any version, including prerelease versions.</td><td style="text-align: left"><code>"*"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-additive_build_file"&gt;&lt;/a&gt;additive_build_file</td><td style="text-align: left">A file containing extra contents to write to the bottom of generated BUILD files.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-additive_build_file_content"&gt;&lt;/a&gt;additive_build_file_content</td><td style="text-align: left">Extra contents to write to the bottom of generated BUILD files.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-alias_rule"&gt;&lt;/a&gt;alias_rule</td><td style="text-align: left">Alias rule to use instead of <code>native.alias()</code>.  Overrides <a href="#render_config">render_config</a>'s 'default_alias_rule'.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_compile_data"&gt;&lt;/a&gt;build_script_compile_data</td><td style="text-align: left">A list of labels to add to a crate's <code>cargo_build_script::compile_data</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_data"&gt;&lt;/a&gt;build_script_data</td><td style="text-align: left">A list of labels to add to a crate's <code>cargo_build_script::data</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_tools"&gt;&lt;/a&gt;build_script_tools</td><td style="text-align: left">A list of labels to add to a crate's <code>cargo_build_script::tools</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_data_glob"&gt;&lt;/a&gt;build_script_data_glob</td><td style="text-align: left">A list of glob patterns to add to a crate's <code>cargo_build_script::data</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_deps"&gt;&lt;/a&gt;build_script_deps</td><td style="text-align: left">A list of labels to add to a crate's <code>cargo_build_script::deps</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_env"&gt;&lt;/a&gt;build_script_env</td><td style="text-align: left">Additional environment variables to set on a crate's <code>cargo_build_script::env</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_proc_macro_deps"&gt;&lt;/a&gt;build_script_proc_macro_deps</td><td style="text-align: left">A list of labels to add to a crate's <code>cargo_build_script::proc_macro_deps</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_rundir"&gt;&lt;/a&gt;build_script_rundir</td><td style="text-align: left">An override for the build script's rundir attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_rustc_env"&gt;&lt;/a&gt;build_script_rustc_env</td><td style="text-align: left">Additional environment variables to set on a crate's <code>cargo_build_script::env</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-build_script_toolchains"&gt;&lt;/a&gt;build_script_toolchains</td><td style="text-align: left">A list of labels to set on a crates's <code>cargo_build_script::toolchains</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-compile_data"&gt;&lt;/a&gt;compile_data</td><td style="text-align: left">A list of labels to add to a crate's <code>rust_library::compile_data</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-compile_data_glob"&gt;&lt;/a&gt;compile_data_glob</td><td style="text-align: left">A list of glob patterns to add to a crate's <code>rust_library::compile_data</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-crate_features"&gt;&lt;/a&gt;crate_features</td><td style="text-align: left">A list of strings to add to a crate's <code>rust_library::crate_features</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-data"&gt;&lt;/a&gt;data</td><td style="text-align: left">A list of labels to add to a crate's <code>rust_library::data</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-data_glob"&gt;&lt;/a&gt;data_glob</td><td style="text-align: left">A list of glob patterns to add to a crate's <code>rust_library::data</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-deps"&gt;&lt;/a&gt;deps</td><td style="text-align: left">A list of labels to add to a crate's <code>rust_library::deps</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-extra_aliased_targets"&gt;&lt;/a&gt;extra_aliased_targets</td><td style="text-align: left">A list of targets to add to the generated aliases in the root crate_universe repository.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-gen_binaries"&gt;&lt;/a&gt;gen_binaries</td><td style="text-align: left">As a list, the subset of the crate's bins that should get <code>rust_binary</code> targets produced. Or <code>True</code> to generate all, <code>False</code> to generate none.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-disable_pipelining"&gt;&lt;/a&gt;disable_pipelining</td><td style="text-align: left">If True, disables pipelining for library targets for this crate.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-gen_build_script"&gt;&lt;/a&gt;gen_build_script</td><td style="text-align: left">An authorative flag to determine whether or not to produce <code>cargo_build_script</code> targets for the current crate.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-patch_args"&gt;&lt;/a&gt;patch_args</td><td style="text-align: left">The <code>patch_args</code> attribute of a Bazel repository rule. See <a href="https://docs.bazel.build/versions/main/repo/http.html#http_archive-patch_args">http_archive.patch_args</a></td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-patch_tool"&gt;&lt;/a&gt;patch_tool</td><td style="text-align: left">The <code>patch_tool</code> attribute of a Bazel repository rule. See <a href="https://docs.bazel.build/versions/main/repo/http.html#http_archive-patch_tool">http_archive.patch_tool</a></td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-patches"&gt;&lt;/a&gt;patches</td><td style="text-align: left">The <code>patches</code> attribute of a Bazel repository rule. See <a href="https://docs.bazel.build/versions/main/repo/http.html#http_archive-patches">http_archive.patches</a></td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-proc_macro_deps"&gt;&lt;/a&gt;proc_macro_deps</td><td style="text-align: left">A list of labels to add to a crate's <code>rust_library::proc_macro_deps</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-rustc_env"&gt;&lt;/a&gt;rustc_env</td><td style="text-align: left">Additional variables to set on a crate's <code>rust_library::rustc_env</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-rustc_env_files"&gt;&lt;/a&gt;rustc_env_files</td><td style="text-align: left">A list of labels to set on a crate's <code>rust_library::rustc_env_files</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-rustc_flags"&gt;&lt;/a&gt;rustc_flags</td><td style="text-align: left">A list of strings to set on a crate's <code>rust_library::rustc_flags</code> attribute.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-shallow_since"&gt;&lt;/a&gt;shallow_since</td><td style="text-align: left">An optional timestamp used for crates originating from a git repository instead of a crate registry. This flag optimizes fetching the source code.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.annotation-override_targets"&gt;&lt;/a&gt;override_targets</td><td style="text-align: left">A dictionary of alternate targets to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Keys can be <code>proc-marco</code>, <code>custom-build</code>, <code>lib</code>, <code>bin</code>.</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>string: A json encoded string containing the specified version and separately all other inputs.</p>
<p>&lt;a id="crate.select"&gt;&lt;/a&gt;</p>
<h2>crate.select</h2>
&lt;pre&gt;
crate.select(&lt;a href="#crate.select-common"&gt;common&lt;/a&gt;, &lt;a href="#crate.select-selects"&gt;selects&lt;/a&gt;)
&lt;/pre&gt;
<p>A Starlark Select for <code>crate.annotation()</code>.</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="crate.select-common"&gt;&lt;/a&gt;common</td><td style="text-align: left">A value that applies to all configurations.</td><td style="text-align: left">none</td></tr>
<tr><td style="text-align: left">&lt;a id="crate.select-selects"&gt;&lt;/a&gt;selects</td><td style="text-align: left">A dict of <code>target_triple</code> to values.</td><td style="text-align: left">none</td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>struct: A struct representing the Starlark Select.</p>
<p>&lt;a id="crate.spec"&gt;&lt;/a&gt;</p>
<h2>crate.spec</h2>
&lt;pre&gt;
crate.spec(&lt;a href="#crate.spec-package"&gt;package&lt;/a&gt;, &lt;a href="#crate.spec-version"&gt;version&lt;/a&gt;, &lt;a href="#crate.spec-artifact"&gt;artifact&lt;/a&gt;, &lt;a href="#crate.spec-lib"&gt;lib&lt;/a&gt;, &lt;a href="#crate.spec-default_features"&gt;default_features&lt;/a&gt;, &lt;a href="#crate.spec-features"&gt;features&lt;/a&gt;, &lt;a href="#crate.spec-git"&gt;git&lt;/a&gt;, &lt;a href="#crate.spec-branch"&gt;branch&lt;/a&gt;, &lt;a href="#crate.spec-tag"&gt;tag&lt;/a&gt;, &lt;a href="#crate.spec-rev"&gt;rev&lt;/a&gt;)
&lt;/pre&gt;
<p>A constructor for a crate dependency.</p>
<p>See <a href="https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html">specifying dependencies</a> in the Cargo book for more details.</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="crate.spec-package"&gt;&lt;/a&gt;package</td><td style="text-align: left">The explicit name of the package (used when attempting to alias a crate).</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-version"&gt;&lt;/a&gt;version</td><td style="text-align: left">The exact version of the crate. Cannot be used with <code>git</code>.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-artifact"&gt;&lt;/a&gt;artifact</td><td style="text-align: left">Set to "bin" to pull in a binary crate as an artifact dependency. Requires a nightly Cargo.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-lib"&gt;&lt;/a&gt;lib</td><td style="text-align: left">If using <code>artifact = "bin"</code>, additionally setting <code>lib = True</code> declares a dependency on both the package's library and binary, as opposed to just the binary.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-default_features"&gt;&lt;/a&gt;default_features</td><td style="text-align: left">Maps to the <code>default-features</code> flag.</td><td style="text-align: left"><code>True</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-features"&gt;&lt;/a&gt;features</td><td style="text-align: left">A list of features to use for the crate</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-git"&gt;&lt;/a&gt;git</td><td style="text-align: left">The Git url to use for the crate. Cannot be used with <code>version</code>.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-branch"&gt;&lt;/a&gt;branch</td><td style="text-align: left">The git branch of the remote crate. Tied with the <code>git</code> param. Only one of branch, tag or rev may be specified. Specifying <code>rev</code> is recommended for fully-reproducible builds.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-tag"&gt;&lt;/a&gt;tag</td><td style="text-align: left">The git tag of the remote crate. Tied with the <code>git</code> param. Only one of branch, tag or rev may be specified. Specifying <code>rev</code> is recommended for fully-reproducible builds.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate.spec-rev"&gt;&lt;/a&gt;rev</td><td style="text-align: left">The git revision of the remote crate. Tied with the <code>git</code> param. Only one of branch, tag or rev may be specified.</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>string: A json encoded string of all inputs</p>
<p>&lt;a id="crate.workspace_member"&gt;&lt;/a&gt;</p>
<h2>crate.workspace_member</h2>
&lt;pre&gt;
crate.workspace_member(&lt;a href="#crate.workspace_member-version"&gt;version&lt;/a&gt;, &lt;a href="#crate.workspace_member-sha256"&gt;sha256&lt;/a&gt;)
&lt;/pre&gt;
<p>Define information for extra workspace members</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="crate.workspace_member-version"&gt;&lt;/a&gt;version</td><td style="text-align: left">The semver of the crate to download. Must be an exact version.</td><td style="text-align: left">none</td></tr>
<tr><td style="text-align: left">&lt;a id="crate.workspace_member-sha256"&gt;&lt;/a&gt;sha256</td><td style="text-align: left">The sha256 checksum of the <code>.crate</code> file.</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>string: A json encoded string of all inputs</p>
<p>&lt;a id="crate_deps"&gt;&lt;/a&gt;</p>
<h2>crate_deps</h2>
&lt;pre&gt;
crate_deps(&lt;a href="#crate_deps-deps"&gt;deps&lt;/a&gt;, &lt;a href="#crate_deps-package_name"&gt;package_name&lt;/a&gt;)
&lt;/pre&gt;
<p>Finds the fully qualified label of the requested crates for the package where this macro is called.</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="crate_deps-deps"&gt;&lt;/a&gt;deps</td><td style="text-align: left">The desired list of crate targets.</td><td style="text-align: left">none</td></tr>
<tr><td style="text-align: left">&lt;a id="crate_deps-package_name"&gt;&lt;/a&gt;package_name</td><td style="text-align: left">The package name of the set of dependencies to look up. Defaults to <code>native.package_name()</code>.</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>list: A list of labels to generated rust targets (str)</p>
<p>&lt;a id="crate_repositories"&gt;&lt;/a&gt;</p>
<h2>crate_repositories</h2>
&lt;pre&gt;
crate_repositories()
&lt;/pre&gt;
<p>A macro for defining repositories for all generated crates.</p>
<p><strong>RETURNS</strong></p>
<p>A list of repos visible to the module through the module extension.</p>
<p>&lt;a id="crate_universe_dependencies"&gt;&lt;/a&gt;</p>
<h2>crate_universe_dependencies</h2>
&lt;pre&gt;
crate_universe_dependencies(&lt;a href="#crate_universe_dependencies-rust_version"&gt;rust_version&lt;/a&gt;, &lt;a href="#crate_universe_dependencies-bootstrap"&gt;bootstrap&lt;/a&gt;, &lt;a href="#crate_universe_dependencies-kwargs"&gt;kwargs&lt;/a&gt;)
&lt;/pre&gt;
<p>Define dependencies of the <code>cargo-bazel</code> Rust target</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="crate_universe_dependencies-rust_version"&gt;&lt;/a&gt;rust_version</td><td style="text-align: left">The version of rust to use when generating dependencies.</td><td style="text-align: left"><code>"1.83.0"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate_universe_dependencies-bootstrap"&gt;&lt;/a&gt;bootstrap</td><td style="text-align: left">If true, a <code>cargo_bootstrap_repository</code> target will be generated.</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crate_universe_dependencies-kwargs"&gt;&lt;/a&gt;kwargs</td><td style="text-align: left">Arguments to pass through to cargo_bazel_bootstrap.</td><td style="text-align: left">none</td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>list[struct(repo=str, is_dev_dep=bool)]: A list of the repositories
defined by this macro.</p>
<p>&lt;a id="render_config"&gt;&lt;/a&gt;</p>
<h2>render_config</h2>
&lt;pre&gt;
render_config(&lt;a href="#render_config-build_file_template"&gt;build_file_template&lt;/a&gt;, &lt;a href="#render_config-crate_label_template"&gt;crate_label_template&lt;/a&gt;, &lt;a href="#render_config-crate_repository_template"&gt;crate_repository_template&lt;/a&gt;,
              &lt;a href="#render_config-crates_module_template"&gt;crates_module_template&lt;/a&gt;, &lt;a href="#render_config-default_alias_rule"&gt;default_alias_rule&lt;/a&gt;, &lt;a href="#render_config-default_package_name"&gt;default_package_name&lt;/a&gt;,
              &lt;a href="#render_config-generate_target_compatible_with"&gt;generate_target_compatible_with&lt;/a&gt;, &lt;a href="#render_config-platforms_template"&gt;platforms_template&lt;/a&gt;, &lt;a href="#render_config-regen_command"&gt;regen_command&lt;/a&gt;, &lt;a href="#render_config-vendor_mode"&gt;vendor_mode&lt;/a&gt;,
              &lt;a href="#render_config-generate_rules_license_metadata"&gt;generate_rules_license_metadata&lt;/a&gt;)
&lt;/pre&gt;
<p>Various settings used to configure rendered outputs</p>
<p>The template parameters each support a select number of format keys. A description of each key
can be found below where the supported keys for each template can be found in the parameter docs</p>
<table><thead><tr><th>key</th><th>definition</th></tr></thead><tbody>
<tr><td><code>name</code></td><td>The name of the crate. Eg <code>tokio</code></td></tr>
<tr><td><code>repository</code></td><td>The rendered repository name for the crate. Directly relates to <code>crate_repository_template</code>.</td></tr>
<tr><td><code>triple</code></td><td>A platform triple. Eg <code>x86_64-unknown-linux-gnu</code></td></tr>
<tr><td><code>version</code></td><td>The crate version. Eg <code>1.2.3</code></td></tr>
<tr><td><code>target</code></td><td>The library or binary target of the crate</td></tr>
<tr><td><code>file</code></td><td>The basename of a file</td></tr>
</tbody></table>
<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="render_config-build_file_template"&gt;&lt;/a&gt;build_file_template</td><td style="text-align: left">The base template to use for BUILD file names. The available format keys are [<code>{name}</code>, {version}`].</td><td style="text-align: left"><code>"//:BUILD.{name}-{version}.bazel"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-crate_label_template"&gt;&lt;/a&gt;crate_label_template</td><td style="text-align: left">The base template to use for crate labels. The available format keys are [<code>{repository}</code>, <code>{name}</code>, <code>{version}</code>, <code>{target}</code>].</td><td style="text-align: left"><code>"@{repository}__{name}-{version}//:{target}"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-crate_repository_template"&gt;&lt;/a&gt;crate_repository_template</td><td style="text-align: left">The base template to use for Crate label repository names. The available format keys are [<code>{repository}</code>, <code>{name}</code>, <code>{version}</code>].</td><td style="text-align: left"><code>"{repository}__{name}-{version}"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-crates_module_template"&gt;&lt;/a&gt;crates_module_template</td><td style="text-align: left">The pattern to use for the <code>defs.bzl</code> and <code>BUILD.bazel</code> file names used for the crates module. The available format keys are [<code>{file}</code>].</td><td style="text-align: left"><code>"//:{file}"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-default_alias_rule"&gt;&lt;/a&gt;default_alias_rule</td><td style="text-align: left">Alias rule to use when generating aliases for all crates.  Acceptable values are 'alias', 'dbg'/'fastbuild'/'opt' (transitions each crate's <code>compilation_mode</code>)  or a string representing a rule in the form '&lt;label to .bzl&gt;:&lt;rule&gt;' that takes a single label parameter 'actual'. See '@crate_index//:alias_rules.bzl' for an example.</td><td style="text-align: left"><code>"alias"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-default_package_name"&gt;&lt;/a&gt;default_package_name</td><td style="text-align: left">The default package name to use in the rendered macros. This affects the auto package detection of things like <code>all_crate_deps</code>.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-generate_target_compatible_with"&gt;&lt;/a&gt;generate_target_compatible_with</td><td style="text-align: left">Whether to generate <code>target_compatible_with</code> annotations on the generated BUILD files.  This catches a <code>target_triple</code>being targeted that isn't declared in <code>supported_platform_triples</code>.</td><td style="text-align: left"><code>True</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-platforms_template"&gt;&lt;/a&gt;platforms_template</td><td style="text-align: left">The base template to use for platform names. See <a href="https://docs.bazel.build/versions/main/platforms.html">platforms documentation</a>. The available format keys are [<code>{triple}</code>].</td><td style="text-align: left"><code>"@rules_rust//rust/platform:{triple}"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-regen_command"&gt;&lt;/a&gt;regen_command</td><td style="text-align: left">An optional command to demonstrate how generated files should be regenerated.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-vendor_mode"&gt;&lt;/a&gt;vendor_mode</td><td style="text-align: left">An optional configuration for rendirng content to be rendered into repositories.</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="render_config-generate_rules_license_metadata"&gt;&lt;/a&gt;generate_rules_license_metadata</td><td style="text-align: left">Whether to generate rules license metedata</td><td style="text-align: left"><code>False</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>string: A json encoded struct to match the Rust <code>config::RenderConfig</code> struct</p>
<p>&lt;a id="splicing_config"&gt;&lt;/a&gt;</p>
<h2>splicing_config</h2>
&lt;pre&gt;
splicing_config(&lt;a href="#splicing_config-resolver_version"&gt;resolver_version&lt;/a&gt;)
&lt;/pre&gt;
<p>Various settings used to configure Cargo manifest splicing behavior.</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="splicing_config-resolver_version"&gt;&lt;/a&gt;resolver_version</td><td style="text-align: left">The <a href="https://doc.rust-lang.org/cargo/reference/resolver.html#resolver-versions">resolver version</a> to use in generated Cargo manifests. This flag is <strong>only</strong> used when splicing a manifest from direct package definitions. See <code>crates_repository::packages</code>.</td><td style="text-align: left"><code>"2"</code></td></tr>
</tbody></table>
<p><strong>RETURNS</strong></p>
<p>str: A json encoded string of the parameters provided</p>
<p>&lt;a id="crates_repository"&gt;&lt;/a&gt;</p>
<h2>crates_repository</h2>
&lt;pre&gt;
crates_repository(&lt;a href="#crates_repository-name"&gt;name&lt;/a&gt;, &lt;a href="#crates_repository-annotations"&gt;annotations&lt;/a&gt;, &lt;a href="#crates_repository-cargo_config"&gt;cargo_config&lt;/a&gt;, &lt;a href="#crates_repository-cargo_lockfile"&gt;cargo_lockfile&lt;/a&gt;, &lt;a href="#crates_repository-generate_binaries"&gt;generate_binaries&lt;/a&gt;,
                  &lt;a href="#crates_repository-generate_build_scripts"&gt;generate_build_scripts&lt;/a&gt;, &lt;a href="#crates_repository-generate_target_compatible_with"&gt;generate_target_compatible_with&lt;/a&gt;, &lt;a href="#crates_repository-generator"&gt;generator&lt;/a&gt;,
                  &lt;a href="#crates_repository-generator_sha256s"&gt;generator_sha256s&lt;/a&gt;, &lt;a href="#crates_repository-generator_urls"&gt;generator_urls&lt;/a&gt;, &lt;a href="#crates_repository-isolated"&gt;isolated&lt;/a&gt;, &lt;a href="#crates_repository-lockfile"&gt;lockfile&lt;/a&gt;, &lt;a href="#crates_repository-manifests"&gt;manifests&lt;/a&gt;, &lt;a href="#crates_repository-packages"&gt;packages&lt;/a&gt;, &lt;a href="#crates_repository-quiet"&gt;quiet&lt;/a&gt;,
                  &lt;a href="#crates_repository-render_config"&gt;render_config&lt;/a&gt;, &lt;a href="#crates_repository-repin_instructions"&gt;repin_instructions&lt;/a&gt;, &lt;a href="#crates_repository-repo_mapping"&gt;repo_mapping&lt;/a&gt;, &lt;a href="#crates_repository-rust_toolchain_cargo_template"&gt;rust_toolchain_cargo_template&lt;/a&gt;,
                  &lt;a href="#crates_repository-rust_toolchain_rustc_template"&gt;rust_toolchain_rustc_template&lt;/a&gt;, &lt;a href="#crates_repository-rust_version"&gt;rust_version&lt;/a&gt;, &lt;a href="#crates_repository-splicing_config"&gt;splicing_config&lt;/a&gt;,
                  &lt;a href="#crates_repository-supported_platform_triples"&gt;supported_platform_triples&lt;/a&gt;)
&lt;/pre&gt;
<p>A rule for defining and downloading Rust dependencies (crates). This rule
handles all the same <a href="#workflows">workflows</a> <code>crate_universe</code> rules do.</p>
<p>Environment Variables:</p>
<table><thead><tr><th>variable</th><th>usage</th></tr></thead><tbody>
<tr><td><code>CARGO_BAZEL_GENERATOR_SHA256</code></td><td>The sha256 checksum of the file located at <code>CARGO_BAZEL_GENERATOR_URL</code></td></tr>
<tr><td><code>CARGO_BAZEL_GENERATOR_URL</code></td><td>The URL of a cargo-bazel binary. This variable takes precedence over attributes and can use <code>file://</code> for local paths</td></tr>
<tr><td><code>CARGO_BAZEL_ISOLATED</code></td><td>An authorative flag as to whether or not the <code>CARGO_HOME</code> environment variable should be isolated from the host configuration</td></tr>
<tr><td><code>CARGO_BAZEL_REPIN</code></td><td>An indicator that the dependencies represented by the rule should be regenerated. <code>REPIN</code> may also be used. See <a href="#repinning--updating-dependencies">Repinning / Updating Dependencies</a> for more details.</td></tr>
<tr><td><code>CARGO_BAZEL_REPIN_ONLY</code></td><td>A comma-delimited allowlist for rules to execute repinning. Can be useful if multiple instances of the repository rule are used in a Bazel workspace, but repinning should be limited to one of them.</td></tr>
</tbody></table>
<p>Example:</p>
<p>Given the following workspace structure:</p>
<pre>[workspace]/
    WORKSPACE.bazel
    BUILD.bazel
    Cargo.toml
    Cargo.Bazel.lock
    src/
        main.rs
</pre>
<p>The following is something that'd be found in the <code>WORKSPACE</code> file:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s>, <a-s>&quot;crates_repository&quot;</a-s>, <a-s>&quot;crate&quot;</a-s>)

<a-f>crates_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;crate_index&quot;</a-s>,
    <a-v>annotations</a-v> <a-o>=</a-o> {
        <a-s>&quot;rand&quot;</a-s>: [<a-v>crate</a-v>.<a-pr>annotation</a-pr>(
            <a-v>default_features</a-v> <a-o>=</a-o> <a-co>False</a-co>,
            <a-v>features</a-v> <a-o>=</a-o> [<a-s>&quot;small_rng&quot;</a-s>],
        )],
    },
    <a-v>cargo_lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:Cargo.Bazel.lock&quot;</a-s>,
    <a-v>lockfile</a-v> <a-o>=</a-o> <a-s>&quot;//:cargo-bazel-lock.json&quot;</a-s>,
    <a-v>manifests</a-v> <a-o>=</a-o> [<a-s>&quot;//:Cargo.toml&quot;</a-s>],
    <a-c># Should match the version represented by the currently registered `rust_toolchain`.</a-c>
    <a-v>rust_version</a-v> <a-o>=</a-o> <a-s>&quot;1.60.0&quot;</a-s>,
)</pre>
<p>The above will create an external repository which contains aliases and macros for accessing
Rust targets found in the dependency graph defined by the given manifests.</p>
<p><strong>NOTE</strong>: The <code>cargo_lockfile</code> and <code>lockfile</code> must be manually created. The rule unfortunately does not yet create
it on its own. When initially setting up this rule, an empty file should be created and then
populated by repinning dependencies.</p>
<h3>Repinning / Updating Dependencies</h3>
<p>Dependency syncing and updating is done in the repository rule which means it's done during the
analysis phase of builds. As mentioned in the environments variable table above, the <code>CARGO_BAZEL_REPIN</code>
(or <code>REPIN</code>) environment variables can be used to force the rule to update dependencies and potentially
render a new lockfile. Given an instance of this repository rule named <code>crate_index</code>, the easiest way to
repin dependencies is to run:</p>
<pre class="language-bash"><a-pr>CARGO_BAZEL_REPIN</a-pr>=1 <a-f>bazel</a-f> sync <a-co>--only=crate_index</a-co></pre>
<p>This will result in all dependencies being updated for a project. The <code>CARGO_BAZEL_REPIN</code> environment variable
can also be used to customize how dependencies are updated. The following table shows translations from environment
variable values to the equivilant <a href="https://doc.rust-lang.org/cargo/commands/cargo-update.html">cargo update</a> command
that is called behind the scenes to update dependencies.</p>
<table><thead><tr><th>Value</th><th>Cargo command</th></tr></thead><tbody>
<tr><td>Any of [<code>true</code>, <code>1</code>, <code>yes</code>, <code>on</code>, <code>workspace</code>]</td><td><code>cargo update --workspace</code></td></tr>
<tr><td>Any of [<code>full</code>, <code>eager</code>, <code>all</code>]</td><td><code>cargo update</code></td></tr>
<tr><td><code>package_name</code></td><td><code>cargo upgrade --package package_name</code></td></tr>
<tr><td><code>package_name@1.2.3</code></td><td><code>cargo upgrade --package package_name@1.2.3</code></td></tr>
<tr><td><code>package_name@1.2.3=4.5.6</code></td><td><code>cargo upgrade --package package_name@1.2.3 --precise=4.5.6</code></td></tr>
</tbody></table>
<p>If the <code>crates_repository</code> is used multiple times in the same Bazel workspace (e.g. for multiple independent
Rust workspaces), it may additionally be useful to use the <code>CARGO_BAZEL_REPIN_ONLY</code> environment variable, which
limits execution of the repinning to one or multiple instances of the <code>crates_repository</code> rule via a comma-delimited
allowlist:</p>
<pre class="language-bash"><a-pr>CARGO_BAZEL_REPIN</a-pr>=1 <a-pr>CARGO_BAZEL_REPIN_ONLY</a-pr>=crate_index <a-f>bazel</a-f> sync <a-co>--only=crate_index</a-co></pre>
<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="crates_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="crates_repository-annotations"&gt;&lt;/a&gt;annotations</td><td style="text-align: left">Extra settings to apply to crates. See <a href="#crateannotation">crate.annotation</a>.</td><td style="text-align: left">&lt;a href="https://bazel.build/rules/lib/dict"&gt;Dictionary: String -&gt; List of strings&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="crates_repository-cargo_config"&gt;&lt;/a&gt;cargo_config</td><td style="text-align: left">A <a href="https://doc.rust-lang.org/cargo/reference/config.html">Cargo configuration</a> 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="crates_repository-cargo_lockfile"&gt;&lt;/a&gt;cargo_lockfile</td><td style="text-align: left">The path used to store the <code>crates_repository</code> specific <a href="https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html">Cargo.lock</a> file. In the case that your <code>crates_repository</code> corresponds directly with an existing <code>Cargo.toml</code> file which has a paired <code>Cargo.lock</code> file, that <code>Cargo.lock</code> file should be used here, which will keep the versions used by cargo and bazel in sync.</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="crates_repository-generate_binaries"&gt;&lt;/a&gt;generate_binaries</td><td style="text-align: left">Whether to generate <code>rust_binary</code> targets for all the binary crates in every package. By default only the <code>rust_library</code> targets are generated.</td><td style="text-align: left">Boolean</td><td style="text-align: left">optional</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="crates_repository-generate_build_scripts"&gt;&lt;/a&gt;generate_build_scripts</td><td style="text-align: left">Whether or not to generate <a href="https://doc.rust-lang.org/cargo/reference/build-scripts.html">cargo build scripts</a> by default.</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="crates_repository-generate_target_compatible_with"&gt;&lt;/a&gt;generate_target_compatible_with</td><td style="text-align: left">DEPRECATED: Moved to <code>render_config</code>.</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="crates_repository-generator"&gt;&lt;/a&gt;generator</td><td style="text-align: left">The absolute label of a generator. Eg. <code>@cargo_bazel_bootstrap//:cargo-bazel</code>. This is typically used when bootstrapping</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="crates_repository-generator_sha256s"&gt;&lt;/a&gt;generator_sha256s</td><td style="text-align: left">Dictionary of <code>host_triple</code> -&gt; <code>sha256</code> for a <code>cargo-bazel</code> binary.</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="crates_repository-generator_urls"&gt;&lt;/a&gt;generator_urls</td><td style="text-align: left">URL template from which to download the <code>cargo-bazel</code> binary. <code>{host_triple}</code> and will be filled in according to the host platform.</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="crates_repository-isolated"&gt;&lt;/a&gt;isolated</td><td style="text-align: left">If true, <code>CARGO_HOME</code> will be overwritten to a directory within the generated repository in order to prevent other uses of Cargo from impacting having any effect on the generated targets produced by this rule. For users who either have multiple <code>crate_repository</code> definitions in a WORKSPACE or rapidly re-pin dependencies, setting this to false may improve build times. This variable is also controled by <code>CARGO_BAZEL_ISOLATED</code> environment variable.</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="crates_repository-lockfile"&gt;&lt;/a&gt;lockfile</td><td style="text-align: left">The path to a file to use for reproducible renderings. If set, this file must exist within the workspace (but can be empty) before this rule will work.</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="crates_repository-manifests"&gt;&lt;/a&gt;manifests</td><td style="text-align: left">A list of Cargo manifests (<code>Cargo.toml</code> files).</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="crates_repository-packages"&gt;&lt;/a&gt;packages</td><td style="text-align: left">A set of crates (packages) specifications to depend on. See <a href="#crate.spec">crate.spec</a>.</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="crates_repository-quiet"&gt;&lt;/a&gt;quiet</td><td style="text-align: left">If stdout and stderr should not be printed to the terminal.</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="crates_repository-render_config"&gt;&lt;/a&gt;render_config</td><td style="text-align: left">The configuration flags to use for rendering. Use <code>//crate_universe:defs.bzl\%render_config</code> to generate the value for this field. If unset, the defaults defined there 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="crates_repository-repin_instructions"&gt;&lt;/a&gt;repin_instructions</td><td style="text-align: left">Instructions to re-pin the repository if required. Many people have wrapper scripts for keeping dependencies up to date, and would like to point users to that instead of the default.</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="crates_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="crates_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>{cfg}</code> (eg. 'exec'), <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="crates_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>{cfg}</code> (eg. 'exec'), <code>{channel}</code> (eg. 'stable'), and <code>{tool}</code> (eg. 'cargo.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="crates_repository-rust_version"&gt;&lt;/a&gt;rust_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>
<tr><td style="text-align: left">&lt;a id="crates_repository-splicing_config"&gt;&lt;/a&gt;splicing_config</td><td style="text-align: left">The configuration flags to use for splicing Cargo maniests. Use <code>//crate_universe:defs.bzl\%rsplicing_config</code> to generate the value for this field. If unset, the defaults defined there 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="crates_repository-supported_platform_triples"&gt;&lt;/a&gt;supported_platform_triples</td><td style="text-align: left">A set of all platform triples to consider when generating dependencies.</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>["aarch64-apple-darwin", "aarch64-apple-ios", "aarch64-apple-ios-sim", "aarch64-linux-android", "aarch64-pc-windows-msvc", "aarch64-unknown-fuchsia", "aarch64-unknown-linux-gnu", "aarch64-unknown-nixos-gnu", "aarch64-unknown-nto-qnx710", "arm-unknown-linux-gnueabi", "armv7-linux-androideabi", "armv7-unknown-linux-gnueabi", "i686-apple-darwin", "i686-linux-android", "i686-pc-windows-msvc", "i686-unknown-freebsd", "i686-unknown-linux-gnu", "powerpc-unknown-linux-gnu", "riscv32imc-unknown-none-elf", "riscv64gc-unknown-none-elf", "s390x-unknown-linux-gnu", "thumbv7em-none-eabi", "thumbv8m.main-none-eabi", "wasm32-unknown-unknown", "wasm32-wasip1", "x86_64-apple-darwin", "x86_64-apple-ios", "x86_64-linux-android", "x86_64-pc-windows-msvc", "x86_64-unknown-freebsd", "x86_64-unknown-fuchsia", "x86_64-unknown-linux-gnu", "x86_64-unknown-nixos-gnu", "x86_64-unknown-none"]</code></td></tr>
</tbody></table>
<p><strong>ENVIRONMENT VARIABLES</strong></p>
<p>This repository rule depends on the following environment variables:</p>
<ul>
<li><code>CARGO_BAZEL_GENERATOR_URL</code></li>
<li><code>CARGO_BAZEL_GENERATOR_SHA256</code></li>
<li><code>CARGO_BAZEL_REPIN</code></li>
<li><code>REPIN</code></li>
<li><code>CARGO_BAZEL_REPIN_ONLY</code></li>
<li><code>CARGO_BAZEL_ISOLATED</code></li>
<li><code>CARGO_BAZEL_DEBUG</code></li>
</ul>
</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>#</a-p> <a-tt>Crate Universe</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Crate Universe is a set of Bazel rule for generating Rust targets using Cargo.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">This doc describes using crate_universe from a WORKSPACE file.</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">If you&#39;re using bzlmod, please see [the bzlmod equivalent of this doc](crate_universe_bzlmod.html).</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>Setup</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">After loading `rules_rust` in your workspace, set the following to begin using `crate_universe`:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></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>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//crate_universe:repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crate_universe_dependencies&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>crate_universe_dependencies()</a-p></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>```</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"><a-p>Note that if the current version of `rules_rust` is not a release artifact, you may need to set additional</a-p></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>flags such as [`bootstrap = True`](#crate_universe_dependencies-bootstrap) on the `crate_universe_dependencies`</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>call above or [crates_repository::generator_urls](#crates_repository-generator_urls) in uses of `crates_repository`.</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"></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>## </a-p><a-tt>Rules</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>- [crates_repository](#crates_repository)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>- [crates_vendor](#crates_vendor)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>## </a-p><a-tt>Utility Macros</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>- [crate_universe_dependencies](#crate_universe_dependencies)</a-p></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>- [crate.annotation](#crateannotation)</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>- [crate.select](#crateselect)</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>- [crate.spec](#cratespec)</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>- [crate.workspace_member](#crateworkspace_member)</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>- [render_config](#render_config)</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>- [splicing_config](#splicing_config)</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>## </a-p><a-tt>Workflows</a-tt></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>The [`crates_repository`](#crates_repository) rule (the primary repository rule of `rules_rust`&#39;s cargo support) supports a number of different</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"><a-p>ways users can express and organize their dependencies. The most common are listed below though there are more to be found in</a-p></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>the [./examples/crate_universe](https://github.com/bazelbuild/rules_rust/tree/main/examples/crate_universe) directory.</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>### </a-p><a-tt>Cargo Workspaces</a-tt></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>One of the simpler ways to wire up dependencies would be to first structure your project into a [Cargo workspace][cw].</a-p></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>The `crates_repository` rule can ingest a root `Cargo.toml` file and generate dependencies from there.</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"></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>```</a-p><a-tl>python</a-tl></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>load(</a-p><a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crates_repository&quot;</a-s><a-p>)</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"></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>crates_repository(</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><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;crate_index&quot;</a-s><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"><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="L57" href="#L57">57</a><span class="code-text"><a-p>    </a-p><a-v>lockfile</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//:Cargo.Bazel.lock&quot;</a-s><a-p>,</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"><a-p>    </a-p><a-v>manifests</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="L59" href="#L59">59</a><span class="code-text"><a-p>)</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"></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>load(</a-p><a-s>&quot;@crate_index//:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crate_repositories&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>crate_repositories()</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>```</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>The generated `crates_repository` contains helper macros which make collecting dependencies for Bazel targets simpler.</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>Notably, the `all_crate_deps` and `aliases` macros (see [Dependencies API](#dependencies-api)) commonly allow the</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.toml` files to be the single source of truth for dependencies. Since these macros come from the generated</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>repository, the dependencies and alias definitions they return will automatically update BUILD targets.</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"></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-tl>python</a-tl></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>load(</a-p><a-s>&quot;@crate_index//:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;aliases&quot;</a-s><a-p>, </a-p><a-s>&quot;all_crate_deps&quot;</a-s><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>load(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_library&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_test&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"></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>rust_library(</a-p></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-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;lib&quot;</a-s><a-p>,</a-p></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-v>aliases</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-f>aliases</a-f><a-p>(),</a-p></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-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-f>all_crate_deps</a-f><a-p>(</a-p></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>normal</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><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></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><a-v>proc_macro_deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-f>all_crate_deps</a-f><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-v>proc_macro</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><a-p>,</a-p></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></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_test(</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;unit_test&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>crate</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:lib&quot;</a-s><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-v>aliases</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-f>aliases</a-f><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><a-v>normal_dev</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><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>proc_macro_dev</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><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><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-f>all_crate_deps</a-f><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"><a-p>        </a-p><a-v>normal_dev</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><a-p>,</a-p></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>    ),</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"><a-p>    </a-p><a-v>proc_macro_deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-f>all_crate_deps</a-f><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>        </a-p><a-v>proc_macro_dev</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><a-p>,</a-p></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>    ),</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"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></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><a-tt>Direct Packages</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></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>In cases where Rust targets have heavy interractions with other Bazel targests ([Cc][cc], [Proto][proto], etc.),</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>maintaining `Cargo.toml` files may have deminishing returns as things like [rust-analyzer][ra] begin to be confused</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>about missing targets or environment variables defined only in Bazel. In workspaces like this, it may be desirable</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>to have a &quot;Cargo free&quot; setup. `crates_repository` supports this through the `packages` attribute.</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"></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>```</a-p><a-tl>python</a-tl></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>load(</a-p><a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crate&quot;</a-s><a-p>, </a-p><a-s>&quot;crates_repository&quot;</a-s><a-p>, </a-p><a-s>&quot;render_config&quot;</a-s><a-p>)</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"></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>crates_repository(</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>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;crate_index&quot;</a-s><a-p>,</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>    </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="L115" href="#L115">115</a><span class="code-text"><a-p>    </a-p><a-v>lockfile</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//:Cargo.Bazel.lock&quot;</a-s><a-p>,</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>    </a-p><a-v>packages</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="L117" href="#L117">117</a><span class="code-text"><a-p>        </a-p><a-s>&quot;async-trait&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</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>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0.1.51&quot;</a-s><a-p>,</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>        ),</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>        </a-p><a-s>&quot;mockall&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</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>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0.10.2&quot;</a-s><a-p>,</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>        ),</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>        </a-p><a-s>&quot;tokio&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</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>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;1.12.0&quot;</a-s><a-p>,</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>        ),</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>    },</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"><a-p>    </a-p><a-c># Setting the default package name to `&quot;&quot;` forces the use of the macros defined in this repository</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>    </a-p><a-c># to always use the root package when looking for dependencies or aliases. This should be considered</a-c></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>    </a-p><a-c># optional as the repository also exposes alises for easy access to all dependencies.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>    </a-p><a-v>render_config</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-f>render_config</a-f><a-p>(</a-p></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-v>default_package_name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>    ),</a-p></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>)</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"></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>load(</a-p><a-s>&quot;@crate_index//:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crate_repositories&quot;</a-s><a-p>)</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>crate_repositories()</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"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"></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>Consuming dependencies may be more ergonomic in this case through the aliases defined in the new repository.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</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="L143" href="#L143">143</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_library&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_test&quot;</a-s><a-p>)</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"></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>rust_library(</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>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;lib&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>deps</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="L148" href="#L148">148</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@crate_index//:tokio&quot;</a-s><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></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>proc_macro_deps</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;@crate_index//:async-trait&quot;</a-s><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></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"></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>rust_test(</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-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;unit_test&quot;</a-s><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-v>crate</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:lib&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><a-v>deps</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="L159" href="#L159">159</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@crate_index//:mockall&quot;</a-s><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"><a-p>```</a-p></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>### </a-p><a-tt>Binary dependencies</a-tt></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"><a-p>Neither of the above approaches supports depending on binary-only packages.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"></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>In order to depend on a Cargo package that contains binaries and no library, you</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>will need to do one of the following:</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>- Fork the package to add an empty lib.rs, which makes the package visible to</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"><a-p>  Cargo metadata and compatible with the above approaches;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"><a-p>- Or handwrite your own build target for the binary, use `http_archive` to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>  import its source code, and use `crates_repository` to make build targets for</a-p></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>  its dependencies. This is demonstrated below using the `rustfilt` crate as an</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"><a-p>  example.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</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="L180" href="#L180">180</a><span class="code-text"><a-p># in WORKSPACE.bazel</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"></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>load(</a-p><a-s>&quot;@bazel_tools//tools/build_defs/repo:http.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;http_archive&quot;</a-s><a-p>)</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"></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>http_archive(</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>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rustfilt&quot;</a-s><a-p>,</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"><a-p>    </a-p><a-v>build_file</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//rustfilt:BUILD.rustfilt.bazel&quot;</a-s><a-p>,</a-p></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-p>    </a-p><a-v>sha256</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;c8d748b182c8f95224336d20dcc5609598af612581ce60cfb29da4dc8d0091f2&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"><a-p>    </a-p><a-v>strip_prefix</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rustfilt-0.2.1&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"><a-p>    </a-p><a-v>type</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;tar.gz&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"><a-p>    </a-p><a-v>urls</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;https://static.crates.io/crates/rustfilt/rustfilt-0.2.1.crate&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crates_repository&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"><a-p>crates_repository(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</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;rustfilt_deps&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</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;//rustfilt:Cargo.lock&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"><a-p>    </a-p><a-v>manifests</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;@rustfilt//:Cargo.toml&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rustfilt_deps//:defs.bzl&quot;</a-s><a-p>, </a-p><a-v>rustfilt_deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;crate_repositories&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"><a-p>rustfilt_deps()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</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="L207" href="#L207">207</a><span class="code-text"><a-p># in rustfilt/BUILD.rustfilt.bazel</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</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></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 class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"><a-p>rust_binary(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</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;rustfilt&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</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-f>glob</a-f><a-p>([</a-p><a-s>&quot;src/**/*.rs&quot;</a-s><a-p>]),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text"><a-p>    </a-p><a-v>edition</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;2018&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@rustfilt_deps//:clap&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@rustfilt_deps//:lazy_static&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@rustfilt_deps//:regex&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@rustfilt_deps//:rustc-demangle&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text"><a-p>    ],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text"><a-p>If you use either `crates_repository` or `crates_vendor` to depend on a Cargo</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text"><a-p>package that contains _both_ a library crate _and_ binaries, by default only the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"><a-p>library gets made available to Bazel. To generate Bazel targets for the binary</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"><a-p>crates as well, you must opt in to it with an annotation on the package:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</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="L230" href="#L230">230</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crates_repository&quot;</a-s><a-p>, </a-p><a-s>&quot;crate&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text"><a-p>crates_repository(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</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;crate_index&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text"><a-p>    </a-p><a-v>annotations</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="L235" href="#L235">235</a><span class="code-text"><a-p>        </a-p><a-s>&quot;thepackage&quot;</a-s><a-p>: [</a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>annotation</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text"><a-p>            </a-p><a-v>gen_binaries</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text"><a-p>            </a-p><a-c># Or, to expose just a subset of the package&#39;s binaries by name:</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text"><a-p>            </a-p><a-v>gen_binaries</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;rustfilt&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text"><a-p>        )],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text"><a-p>    },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text"><a-p>    </a-p><a-c># Or, to expose every binary of every package:</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text"><a-p>    </a-p><a-v>generate_binaries</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>True</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text"><a-p>    ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text"><a-p>## </a-p><a-tt>Dependencies API</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text"><a-p>After rendering dependencies, convenience macros may also be generated to provide</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text"><a-p>convenient accessors to larger sections of the dependency graph.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text"><a-p>- [aliases](#aliases)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text"><a-p>- [crate_deps](#crate_deps)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text"><a-p>- [all_crate_deps](#all_crate_deps)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"><a-p>- [crate_repositories](#crate_repositories)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text"><a-p>## </a-p><a-tt>Building crates with complicated dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text"><a-p>Some crates have build.rs scripts which are complicated to run. Typically these build C++ (or other languages), or attempt to find pre-installed libraries on the build machine.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text"><a-p>There are a few approaches to making sure these run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text"><a-p>### </a-p><a-tt>Some things work without intervention</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text"><a-p>Some build scripts will happily run without any support needed.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text"><a-p>rules_rust already supplies a configured C++ toolchain as input to build script execution, and sets variables like `CC`, `CXX`, `LD`, `LDFLAGS`, etc as needed. Many crates which invoke a compiler with the default environment, or forward these env vars, will Just Work (e.g. if using [`cc-rs`][cc-rs]).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text"><a-p>rules_rust is open to PRs which make build scripts more likely to work by default with intervention assuming they&#39;re broadly applicable (e.g. setting extra widely-known env vars is probably fine, wiring up additional toolchains like `cmake` that aren&#39;t present by default for most Bazel users probably isn&#39;t).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text"><a-p>### </a-p><a-tt>Supplying extra tools to build</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text"><a-p>Some build scripts can be made to work by pulling in some extra files and making them available to the build script.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text"><a-p>Commonly this is done by passing the file to the `build_script_data` annotation for the crate, and using `build_script_env` to tell the build script where the file is. That env var may often use `$(execroot)` to get the path to the label, or `$${pwd}/` as a prefix if the path given is relative to the execroot (as will frequently happen when using a toolchain).A</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text"><a-p>There is an example of this in the &quot;complicated dependencies&quot; section of https://github.com/bazelbuild/rules_rust/blob/main/examples/crate_universe/WORKSPACE.bazel which builds libz-ng-sys.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text"><a-p>### </a-p><a-tt>Building with Bazel and supplying via an override</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text"><a-p>Some build scripts have hooks to allow replacing parts that are complicated to build with output prepared by Bazel.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text"><a-p>We can use those hooks by specifying paths (generally using the `build_script_data` and `build_script_env` annotations) and pointing them at labels which Bazel will then build. These env vars may often use `$(execroot)` to get the path to the label, or `$${pwd}/` as a prefix if the path given is relative to the execroot (as will frequently happen when using a toolchain).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text"><a-p>There is an example of this in the &quot;complicated dependencies&quot; section of https://github.com/bazelbuild/rules_rust/blob/main/examples/crate_universe/WORKSPACE.bazel which builds boring-sys.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L288" href="#L288">288</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text"><a-tu>[cw]</a-tu><a-p>: </a-p><a-tu>https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text"><a-tu>[cc]</a-tu><a-p>: </a-p><a-tu>https://docs.bazel.build/versions/main/be/c-cpp.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</a><span class="code-text"><a-tu>[proto]</a-tu><a-p>: </a-p><a-tu>https://rules-proto-grpc.com/en/latest/lang/rust.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L294" href="#L294">294</a><span class="code-text"><a-tu>[ra]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L295" href="#L295">295</a><span class="code-text"><a-tu>[cc-rs]</a-tu><a-p>: </a-p><a-tu>https://github.com/rust-lang/cc-rs</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L296" href="#L296">296</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text"><a-p>&lt;a id=&quot;crates_vendor&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text"><a-p>## </a-p><a-tt>crates_vendor</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</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="L302" href="#L302">302</a><span class="code-text"><a-p>crates_vendor(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#crates_vendor-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>#crates_vendor-annotations</a-s><a-p>&quot;&gt;annotations&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>#crates_vendor-bazel</a-s><a-p>&quot;&gt;bazel&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>#crates_vendor-buildifier</a-s><a-p>&quot;&gt;buildifier&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>#crates_vendor-cargo_bazel</a-s><a-p>&quot;&gt;cargo_bazel&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>#crates_vendor-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>#crates_vendor-cargo_lockfile</a-s><a-p>&quot;&gt;cargo_lockfile&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="L303" href="#L303">303</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>#crates_vendor-generate_binaries</a-s><a-p>&quot;&gt;generate_binaries&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>#crates_vendor-generate_build_scripts</a-s><a-p>&quot;&gt;generate_build_scripts&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>#crates_vendor-generate_target_compatible_with</a-s><a-p>&quot;&gt;generate_target_compatible_with&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>#crates_vendor-manifests</a-s><a-p>&quot;&gt;manifests&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="L304" href="#L304">304</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>#crates_vendor-mode</a-s><a-p>&quot;&gt;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>#crates_vendor-packages</a-s><a-p>&quot;&gt;packages&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>#crates_vendor-render_config</a-s><a-p>&quot;&gt;render_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>#crates_vendor-repository_name</a-s><a-p>&quot;&gt;repository_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>#crates_vendor-splicing_config</a-s><a-p>&quot;&gt;splicing_config&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="L305" href="#L305">305</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>#crates_vendor-supported_platform_triples</a-s><a-p>&quot;&gt;supported_platform_triples&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>#crates_vendor-vendor_path</a-s><a-p>&quot;&gt;vendor_path&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="L306" href="#L306">306</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="L307" href="#L307">307</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L308" href="#L308">308</a><span class="code-text"><a-p>A rule for defining Rust dependencies (crates) and writing targets for them to the current workspace.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L309" href="#L309">309</a><span class="code-text"><a-p>This rule is useful for users whose workspaces are expected to be consumed in other workspaces as the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L310" href="#L310">310</a><span class="code-text"><a-p>rendered `BUILD` files reduce the number of workspace dependencies, allowing for easier loads. This rule</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L311" href="#L311">311</a><span class="code-text"><a-p>handles all the same [workflows](#workflows) `crate_universe` rules do.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L312" href="#L312">312</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L313" href="#L313">313</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="L314" href="#L314">314</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L315" href="#L315">315</a><span class="code-text"><a-p>Given the following workspace structure:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L316" href="#L316">316</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L317" href="#L317">317</a><span class="code-text"><a-p>```</a-p><a-tl>text</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L318" href="#L318">318</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="L319" href="#L319">319</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="L320" href="#L320">320</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="L321" href="#L321">321</a><span class="code-text"><a-p>    Cargo.toml</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L322" href="#L322">322</a><span class="code-text"><a-p>    3rdparty/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L323" href="#L323">323</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="L324" href="#L324">324</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="L325" href="#L325">325</a><span class="code-text"><a-p>        main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L326" href="#L326">326</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L327" href="#L327">327</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L328" href="#L328">328</a><span class="code-text"><a-p>The following is something that&#39;d be found in `3rdparty/BUILD`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L329" href="#L329">329</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L330" href="#L330">330</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="L331" href="#L331">331</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crates_vendor&quot;</a-s><a-p>, </a-p><a-s>&quot;crate&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L332" href="#L332">332</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L333" href="#L333">333</a><span class="code-text"><a-p>crates_vendor(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L334" href="#L334">334</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;crates_vendor&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L335" href="#L335">335</a><span class="code-text"><a-p>    </a-p><a-v>annotations</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="L336" href="#L336">336</a><span class="code-text"><a-p>        </a-p><a-s>&quot;rand&quot;</a-s><a-p>: [</a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>annotation</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L337" href="#L337">337</a><span class="code-text"><a-p>            </a-p><a-v>default_features</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>False</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L338" href="#L338">338</a><span class="code-text"><a-p>            </a-p><a-v>features</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;small_rng&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L339" href="#L339">339</a><span class="code-text"><a-p>        )],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L340" href="#L340">340</a><span class="code-text"><a-p>    },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L341" href="#L341">341</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.Bazel.lock&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L342" href="#L342">342</a><span class="code-text"><a-p>    </a-p><a-v>manifests</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="L343" href="#L343">343</a><span class="code-text"><a-p>    </a-p><a-v>mode</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;remote&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L344" href="#L344">344</a><span class="code-text"><a-p>    </a-p><a-v>vendor_path</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;crates&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L345" href="#L345">345</a><span class="code-text"><a-p>    </a-p><a-v>tags</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;manual&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L346" href="#L346">346</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L347" href="#L347">347</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L348" href="#L348">348</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L349" href="#L349">349</a><span class="code-text"><a-p>The above creates a target that can be run to write `BUILD` files into the `3rdparty`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L350" href="#L350">350</a><span class="code-text"><a-p>directory next to where the target is defined. To run it, simply call:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L351" href="#L351">351</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L352" href="#L352">352</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L353" href="#L353">353</a><span class="code-text"><a-p>bazel run //3rdparty:crates_vendor</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L354" href="#L354">354</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L355" href="#L355">355</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L356" href="#L356">356</a><span class="code-text"><a-p>### </a-p><a-tt>Patching</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L357" href="#L357">357</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L358" href="#L358">358</a><span class="code-text"><a-p>If you need to replace crates in your third_party dependency tree with forks, the `patch` section can be used in your cargo manifest:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L359" href="#L359">359</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L360" href="#L360">360</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L361" href="#L361">361</a><span class="code-text"><a-p>[</a-p><a-pr>patch</a-pr><a-p>.</a-p><a-pr>crates-io</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L362" href="#L362">362</a><span class="code-text"><a-p>fuse3 </a-p><a-o>=</a-o><a-p> { </a-p><a-pr>path</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;forks/fuse3&quot;</a-s><a-p> }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L363" href="#L363">363</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L364" href="#L364">364</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L365" href="#L365">365</a><span class="code-text"><a-p>A build file for the patched crate will still be generated under the vendor path</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L366" href="#L366">366</a><span class="code-text"><a-p>(such as `crates/fuse3-0.6.1/BUILD.bazel`), but `cargo vendor` will NOT download the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L367" href="#L367">367</a><span class="code-text"><a-p>crate to that location, and the generated BUILD file will point to your copy. For this</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L368" href="#L368">368</a><span class="code-text"><a-p>to work, you need to define the following filegroups in your patch crate&#39;s BUILD.bazel:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L369" href="#L369">369</a><span class="code-text"><a-p>`:srcs`, `:crate_root`, `:compile_data`, and (if the crate has a build script)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L370" href="#L370">370</a><span class="code-text"><a-p>`:build_script_crate_root`. See the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L371" href="#L371">371</a><span class="code-text"><a-p>[patching example](https://github.com/bazelbuild/rules_rust/tree/main/examples/crate_universe/vendor_local_patching)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L372" href="#L372">372</a><span class="code-text"><a-p>for an example of what those BUILD files look like.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L373" href="#L373">373</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L374" href="#L374">374</a><span class="code-text"><a-p>This feature can also be used to avoid vendoring source code for crates that you never</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L375" href="#L375">375</a><span class="code-text"><a-p>actually use for the platforms you&#39;re targeting. In that case you don&#39;t need an extra</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L376" href="#L376">376</a><span class="code-text"><a-p>BUILD file, just crate a empty/stub Cargo.toml and `lib.rs`, and list the path to that</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L377" href="#L377">377</a><span class="code-text"><a-p>in your `patch` section.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L378" href="#L378">378</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L379" href="#L379">379</a><span class="code-text"><a-p>&lt;a id=&quot;#crates_vendor_repinning_updating_dependencies&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L380" href="#L380">380</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L381" href="#L381">381</a><span class="code-text"><a-p>### </a-p><a-tt>Repinning / Updating Dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L382" href="#L382">382</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L383" href="#L383">383</a><span class="code-text"><a-p>Repinning dependencies is controlled by both the `CARGO_BAZEL_REPIN` environment variable or the `--repin`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L384" href="#L384">384</a><span class="code-text"><a-p>flag to the `crates_vendor` binary. To update dependencies, simply add the flag to your `bazel run` invocation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L385" href="#L385">385</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L386" href="#L386">386</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L387" href="#L387">387</a><span class="code-text"><a-p>bazel run //3rdparty:crates_vendor -- --repin</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L388" href="#L388">388</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L389" href="#L389">389</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L390" href="#L390">390</a><span class="code-text"><a-p>Under the hood, `--repin` will trigger a [cargo update](https://doc.rust-lang.org/cargo/commands/cargo-update.html)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L391" href="#L391">391</a><span class="code-text"><a-p>call against the generated workspace. The following table describes how to control particular values passed to the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L392" href="#L392">392</a><span class="code-text"><a-p>`cargo update` command.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L393" href="#L393">393</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L394" href="#L394">394</a><span class="code-text"><a-p>| Value | Cargo command |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L395" href="#L395">395</a><span class="code-text"><a-p>| --- | --- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L396" href="#L396">396</a><span class="code-text"><a-p>| Any of [`true`, `1`, `yes`, `on`, `workspace`] | `cargo update --workspace` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L397" href="#L397">397</a><span class="code-text"><a-p>| Any of [`full`, `eager`, `all`] | `cargo update` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L398" href="#L398">398</a><span class="code-text"><a-p>| `package_name` | `cargo upgrade --package package_name` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L399" href="#L399">399</a><span class="code-text"><a-p>| `package_name@1.2.3` | `cargo upgrade --package package_name --precise 1.2.3` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L400" href="#L400">400</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L401" href="#L401">401</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="L402" href="#L402">402</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L403" href="#L403">403</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L404" href="#L404">404</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="L405" href="#L405">405</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L406" href="#L406">406</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-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="L407" href="#L407">407</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-annotations&quot;&gt;&lt;/a&gt;annotations |  Extra settings to apply to crates. See [crate.annotation](#crateannotation).   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; List of strings&lt;/a&gt; | optional |  `{}`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L408" href="#L408">408</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-bazel&quot;&gt;&lt;/a&gt;bazel |  The path to a bazel binary used to locate the output_base for the current workspace.   | &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="L409" href="#L409">409</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-buildifier&quot;&gt;&lt;/a&gt;buildifier |  The path to a [buildifier](https://github.com/bazelbuild/buildtools/blob/5.0.1/buildifier/README.md) binary used to format generated BUILD files.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `&quot;@rules_rust//crate_universe/private/vendor:buildifier&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L410" href="#L410">410</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-cargo_bazel&quot;&gt;&lt;/a&gt;cargo_bazel |  The cargo-bazel binary to use for vendoring. If this attribute is not set, then a `CARGO_BAZEL_GENERATOR_PATH` action env will be used.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `&quot;@@rules_rust~~cargo_bazel_bootstrap~cargo_bazel_bootstrap//:binary&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L411" href="#L411">411</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-cargo_config&quot;&gt;&lt;/a&gt;cargo_config |  A [Cargo configuration](https://doc.rust-lang.org/cargo/reference/config.html) file.   | &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="L412" href="#L412">412</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-cargo_lockfile&quot;&gt;&lt;/a&gt;cargo_lockfile |  The path to an existing `Cargo.lock` file   | &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="L413" href="#L413">413</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-generate_binaries&quot;&gt;&lt;/a&gt;generate_binaries |  Whether to generate `rust_binary` targets for all the binary crates in every package. By default only the `rust_library` targets are generated.   | Boolean | optional |  `False`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L414" href="#L414">414</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-generate_build_scripts&quot;&gt;&lt;/a&gt;generate_build_scripts |  Whether or not to generate [cargo build scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html) by default.   | Boolean | optional |  `True`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L415" href="#L415">415</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-generate_target_compatible_with&quot;&gt;&lt;/a&gt;generate_target_compatible_with |  DEPRECATED: Moved to `render_config`.   | Boolean | optional |  `True`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L416" href="#L416">416</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-manifests&quot;&gt;&lt;/a&gt;manifests |  A list of Cargo manifests (`Cargo.toml` files).   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | optional |  `[]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L417" href="#L417">417</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-mode&quot;&gt;&lt;/a&gt;mode |  Flags determining how crates should be vendored. `local` is where crate source and BUILD files are written to the repository. `remote` is where only BUILD files are written and repository rules used to fetch source code.   | String | optional |  `&quot;remote&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L418" href="#L418">418</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-packages&quot;&gt;&lt;/a&gt;packages |  A set of crates (packages) specifications to depend on. See [crate.spec](#crate.spec).   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; String&lt;/a&gt; | optional |  `{}`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L419" href="#L419">419</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-render_config&quot;&gt;&lt;/a&gt;render_config |  The configuration flags to use for rendering. Use `//crate_universe:defs.bzl\%render_config` to generate the value for this field. If unset, the defaults defined there will be used.   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L420" href="#L420">420</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-repository_name&quot;&gt;&lt;/a&gt;repository_name |  The name of the repository to generate for `remote` vendor modes. If unset, the label name will be used   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L421" href="#L421">421</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-splicing_config&quot;&gt;&lt;/a&gt;splicing_config |  The configuration flags to use for splicing Cargo maniests. Use `//crate_universe:defs.bzl\%rsplicing_config` to generate the value for this field. If unset, the defaults defined there will be used.   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L422" href="#L422">422</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-supported_platform_triples&quot;&gt;&lt;/a&gt;supported_platform_triples |  A set of all platform triples to consider when generating dependencies.   | List of strings | optional |  `[&quot;aarch64-apple-darwin&quot;, &quot;aarch64-apple-ios&quot;, &quot;aarch64-apple-ios-sim&quot;, &quot;aarch64-linux-android&quot;, &quot;aarch64-pc-windows-msvc&quot;, &quot;aarch64-unknown-fuchsia&quot;, &quot;aarch64-unknown-linux-gnu&quot;, &quot;aarch64-unknown-nixos-gnu&quot;, &quot;aarch64-unknown-nto-qnx710&quot;, &quot;arm-unknown-linux-gnueabi&quot;, &quot;armv7-linux-androideabi&quot;, &quot;armv7-unknown-linux-gnueabi&quot;, &quot;i686-apple-darwin&quot;, &quot;i686-linux-android&quot;, &quot;i686-pc-windows-msvc&quot;, &quot;i686-unknown-freebsd&quot;, &quot;i686-unknown-linux-gnu&quot;, &quot;powerpc-unknown-linux-gnu&quot;, &quot;riscv32imc-unknown-none-elf&quot;, &quot;riscv64gc-unknown-none-elf&quot;, &quot;s390x-unknown-linux-gnu&quot;, &quot;thumbv7em-none-eabi&quot;, &quot;thumbv8m.main-none-eabi&quot;, &quot;wasm32-unknown-unknown&quot;, &quot;wasm32-wasip1&quot;, &quot;x86_64-apple-darwin&quot;, &quot;x86_64-apple-ios&quot;, &quot;x86_64-linux-android&quot;, &quot;x86_64-pc-windows-msvc&quot;, &quot;x86_64-unknown-freebsd&quot;, &quot;x86_64-unknown-fuchsia&quot;, &quot;x86_64-unknown-linux-gnu&quot;, &quot;x86_64-unknown-nixos-gnu&quot;, &quot;x86_64-unknown-none&quot;]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L423" href="#L423">423</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_vendor-vendor_path&quot;&gt;&lt;/a&gt;vendor_path |  The path to a directory to write files into. Absolute paths will be treated as relative to the workspace root   | String | optional |  `&quot;crates&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L424" href="#L424">424</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L425" href="#L425">425</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L426" href="#L426">426</a><span class="code-text"><a-p>&lt;a id=&quot;aliases&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L427" href="#L427">427</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L428" href="#L428">428</a><span class="code-text"><a-p>## </a-p><a-tt>aliases</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L429" href="#L429">429</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L430" href="#L430">430</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="L431" href="#L431">431</a><span class="code-text"><a-p>aliases(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#aliases-normal</a-s><a-p>&quot;&gt;normal&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>#aliases-normal_dev</a-s><a-p>&quot;&gt;normal_dev&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>#aliases-proc_macro</a-s><a-p>&quot;&gt;proc_macro&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>#aliases-proc_macro_dev</a-s><a-p>&quot;&gt;proc_macro_dev&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>#aliases-build</a-s><a-p>&quot;&gt;build&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>#aliases-build_proc_macro</a-s><a-p>&quot;&gt;build_proc_macro&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>#aliases-package_name</a-s><a-p>&quot;&gt;package_name&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="L432" href="#L432">432</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="L433" href="#L433">433</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L434" href="#L434">434</a><span class="code-text"><a-p>Produces a map of Crate alias names to their original label</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L435" href="#L435">435</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L436" href="#L436">436</a><span class="code-text"><a-p>If no dependency kinds are specified, `normal` and `proc_macro` are used by default.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L437" href="#L437">437</a><span class="code-text"><a-p>Setting any one flag will otherwise determine the contents of the returned dict.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L438" href="#L438">438</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L439" href="#L439">439</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L440" href="#L440">440</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="L441" href="#L441">441</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L442" href="#L442">442</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L443" href="#L443">443</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="L444" href="#L444">444</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L445" href="#L445">445</a><span class="code-text"><a-p>| &lt;a id=&quot;aliases-normal&quot;&gt;&lt;/a&gt;normal |  If True, normal dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L446" href="#L446">446</a><span class="code-text"><a-p>| &lt;a id=&quot;aliases-normal_dev&quot;&gt;&lt;/a&gt;normal_dev |  If True, normal dev dependencies will be included in the output list..   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L447" href="#L447">447</a><span class="code-text"><a-p>| &lt;a id=&quot;aliases-proc_macro&quot;&gt;&lt;/a&gt;proc_macro |  If True, proc_macro dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L448" href="#L448">448</a><span class="code-text"><a-p>| &lt;a id=&quot;aliases-proc_macro_dev&quot;&gt;&lt;/a&gt;proc_macro_dev |  If True, dev proc_macro dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L449" href="#L449">449</a><span class="code-text"><a-p>| &lt;a id=&quot;aliases-build&quot;&gt;&lt;/a&gt;build |  If True, build dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L450" href="#L450">450</a><span class="code-text"><a-p>| &lt;a id=&quot;aliases-build_proc_macro&quot;&gt;&lt;/a&gt;build_proc_macro |  If True, build proc_macro dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L451" href="#L451">451</a><span class="code-text"><a-p>| &lt;a id=&quot;aliases-package_name&quot;&gt;&lt;/a&gt;package_name |  The package name of the set of dependencies to look up. Defaults to `native.package_name()` when unset.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L452" href="#L452">452</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L453" href="#L453">453</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="L454" href="#L454">454</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L455" href="#L455">455</a><span class="code-text"><a-p>dict: The aliases of all associated packages</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L456" href="#L456">456</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L457" href="#L457">457</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L458" href="#L458">458</a><span class="code-text"><a-p>&lt;a id=&quot;all_crate_deps&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L459" href="#L459">459</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L460" href="#L460">460</a><span class="code-text"><a-p>## </a-p><a-tt>all_crate_deps</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L461" href="#L461">461</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L462" href="#L462">462</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="L463" href="#L463">463</a><span class="code-text"><a-p>all_crate_deps(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#all_crate_deps-normal</a-s><a-p>&quot;&gt;normal&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>#all_crate_deps-normal_dev</a-s><a-p>&quot;&gt;normal_dev&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>#all_crate_deps-proc_macro</a-s><a-p>&quot;&gt;proc_macro&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>#all_crate_deps-proc_macro_dev</a-s><a-p>&quot;&gt;proc_macro_dev&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>#all_crate_deps-build</a-s><a-p>&quot;&gt;build&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>#all_crate_deps-build_proc_macro</a-s><a-p>&quot;&gt;build_proc_macro&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="L464" href="#L464">464</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>#all_crate_deps-package_name</a-s><a-p>&quot;&gt;package_name&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="L465" href="#L465">465</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="L466" href="#L466">466</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L467" href="#L467">467</a><span class="code-text"><a-p>Finds the fully qualified label of all requested direct crate dependencies     for the package where this macro is called.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L468" href="#L468">468</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L469" href="#L469">469</a><span class="code-text"><a-p>If no parameters are set, all normal dependencies are returned. Setting any one flag will</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L470" href="#L470">470</a><span class="code-text"><a-p>otherwise impact the contents of the returned list.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L471" href="#L471">471</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L472" href="#L472">472</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L473" href="#L473">473</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="L474" href="#L474">474</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L475" href="#L475">475</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L476" href="#L476">476</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="L477" href="#L477">477</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L478" href="#L478">478</a><span class="code-text"><a-p>| &lt;a id=&quot;all_crate_deps-normal&quot;&gt;&lt;/a&gt;normal |  If True, normal dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L479" href="#L479">479</a><span class="code-text"><a-p>| &lt;a id=&quot;all_crate_deps-normal_dev&quot;&gt;&lt;/a&gt;normal_dev |  If True, normal dev dependencies will be included in the output list..   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L480" href="#L480">480</a><span class="code-text"><a-p>| &lt;a id=&quot;all_crate_deps-proc_macro&quot;&gt;&lt;/a&gt;proc_macro |  If True, proc_macro dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L481" href="#L481">481</a><span class="code-text"><a-p>| &lt;a id=&quot;all_crate_deps-proc_macro_dev&quot;&gt;&lt;/a&gt;proc_macro_dev |  If True, dev proc_macro dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L482" href="#L482">482</a><span class="code-text"><a-p>| &lt;a id=&quot;all_crate_deps-build&quot;&gt;&lt;/a&gt;build |  If True, build dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L483" href="#L483">483</a><span class="code-text"><a-p>| &lt;a id=&quot;all_crate_deps-build_proc_macro&quot;&gt;&lt;/a&gt;build_proc_macro |  If True, build proc_macro dependencies are included in the output list.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L484" href="#L484">484</a><span class="code-text"><a-p>| &lt;a id=&quot;all_crate_deps-package_name&quot;&gt;&lt;/a&gt;package_name |  The package name of the set of dependencies to look up. Defaults to `native.package_name()` when unset.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L485" href="#L485">485</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L486" href="#L486">486</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="L487" href="#L487">487</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L488" href="#L488">488</a><span class="code-text"><a-p>list: A list of labels to generated rust targets (str)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L489" href="#L489">489</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L490" href="#L490">490</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L491" href="#L491">491</a><span class="code-text"><a-p>&lt;a id=&quot;crate.annotation&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L492" href="#L492">492</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L493" href="#L493">493</a><span class="code-text"><a-p>## </a-p><a-tt>crate.annotation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L494" href="#L494">494</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L495" href="#L495">495</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="L496" href="#L496">496</a><span class="code-text"><a-p>crate.annotation(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#crate.annotation-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>#crate.annotation-additive_build_file</a-s><a-p>&quot;&gt;additive_build_file&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>#crate.annotation-additive_build_file_content</a-s><a-p>&quot;&gt;additive_build_file_content&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>#crate.annotation-alias_rule</a-s><a-p>&quot;&gt;alias_rule&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="L497" href="#L497">497</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>#crate.annotation-build_script_compile_data</a-s><a-p>&quot;&gt;build_script_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>#crate.annotation-build_script_data</a-s><a-p>&quot;&gt;build_script_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>#crate.annotation-build_script_tools</a-s><a-p>&quot;&gt;build_script_tools&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="L498" href="#L498">498</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>#crate.annotation-build_script_data_glob</a-s><a-p>&quot;&gt;build_script_data_glob&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>#crate.annotation-build_script_deps</a-s><a-p>&quot;&gt;build_script_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>#crate.annotation-build_script_env</a-s><a-p>&quot;&gt;build_script_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="L499" href="#L499">499</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>#crate.annotation-build_script_proc_macro_deps</a-s><a-p>&quot;&gt;build_script_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>#crate.annotation-build_script_rundir</a-s><a-p>&quot;&gt;build_script_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>#crate.annotation-build_script_rustc_env</a-s><a-p>&quot;&gt;build_script_rustc_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="L500" href="#L500">500</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>#crate.annotation-build_script_toolchains</a-s><a-p>&quot;&gt;build_script_toolchains&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>#crate.annotation-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>#crate.annotation-compile_data_glob</a-s><a-p>&quot;&gt;compile_data_glob&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>#crate.annotation-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>#crate.annotation-data</a-s><a-p>&quot;&gt;data&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="L501" href="#L501">501</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>#crate.annotation-data_glob</a-s><a-p>&quot;&gt;data_glob&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>#crate.annotation-deps</a-s><a-p>&quot;&gt;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>#crate.annotation-extra_aliased_targets</a-s><a-p>&quot;&gt;extra_aliased_targets&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>#crate.annotation-gen_binaries</a-s><a-p>&quot;&gt;gen_binaries&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>#crate.annotation-disable_pipelining</a-s><a-p>&quot;&gt;disable_pipelining&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="L502" href="#L502">502</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>#crate.annotation-gen_build_script</a-s><a-p>&quot;&gt;gen_build_script&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>#crate.annotation-patch_args</a-s><a-p>&quot;&gt;patch_args&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>#crate.annotation-patch_tool</a-s><a-p>&quot;&gt;patch_tool&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>#crate.annotation-patches</a-s><a-p>&quot;&gt;patches&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>#crate.annotation-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>#crate.annotation-rustc_env</a-s><a-p>&quot;&gt;rustc_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="L503" href="#L503">503</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>#crate.annotation-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>#crate.annotation-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>#crate.annotation-shallow_since</a-s><a-p>&quot;&gt;shallow_since&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>#crate.annotation-override_targets</a-s><a-p>&quot;&gt;override_targets&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="L504" href="#L504">504</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="L505" href="#L505">505</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L506" href="#L506">506</a><span class="code-text"><a-p>A collection of extra attributes and settings for a particular crate</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L507" href="#L507">507</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L508" href="#L508">508</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="L509" href="#L509">509</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L510" href="#L510">510</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L511" href="#L511">511</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="L512" href="#L512">512</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L513" href="#L513">513</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-version&quot;&gt;&lt;/a&gt;version |  The version or semver-conditions to match with a crate. The wildcard `*` matches any version, including prerelease versions.   |  `&quot;*&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L514" href="#L514">514</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-additive_build_file&quot;&gt;&lt;/a&gt;additive_build_file |  A file containing extra contents to write to the bottom of generated BUILD files.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L515" href="#L515">515</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-additive_build_file_content&quot;&gt;&lt;/a&gt;additive_build_file_content |  Extra contents to write to the bottom of generated BUILD files.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L516" href="#L516">516</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-alias_rule&quot;&gt;&lt;/a&gt;alias_rule |  Alias rule to use instead of `native.alias()`.  Overrides [render_config](#render_config)&#39;s &#39;default_alias_rule&#39;.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L517" href="#L517">517</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_compile_data&quot;&gt;&lt;/a&gt;build_script_compile_data |  A list of labels to add to a crate&#39;s `cargo_build_script::compile_data` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L518" href="#L518">518</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_data&quot;&gt;&lt;/a&gt;build_script_data |  A list of labels to add to a crate&#39;s `cargo_build_script::data` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L519" href="#L519">519</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_tools&quot;&gt;&lt;/a&gt;build_script_tools |  A list of labels to add to a crate&#39;s `cargo_build_script::tools` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L520" href="#L520">520</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_data_glob&quot;&gt;&lt;/a&gt;build_script_data_glob |  A list of glob patterns to add to a crate&#39;s `cargo_build_script::data` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L521" href="#L521">521</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_deps&quot;&gt;&lt;/a&gt;build_script_deps |  A list of labels to add to a crate&#39;s `cargo_build_script::deps` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L522" href="#L522">522</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_env&quot;&gt;&lt;/a&gt;build_script_env |  Additional environment variables to set on a crate&#39;s `cargo_build_script::env` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L523" href="#L523">523</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_proc_macro_deps&quot;&gt;&lt;/a&gt;build_script_proc_macro_deps |  A list of labels to add to a crate&#39;s `cargo_build_script::proc_macro_deps` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L524" href="#L524">524</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_rundir&quot;&gt;&lt;/a&gt;build_script_rundir |  An override for the build script&#39;s rundir attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L525" href="#L525">525</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_rustc_env&quot;&gt;&lt;/a&gt;build_script_rustc_env |  Additional environment variables to set on a crate&#39;s `cargo_build_script::env` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L526" href="#L526">526</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-build_script_toolchains&quot;&gt;&lt;/a&gt;build_script_toolchains |  A list of labels to set on a crates&#39;s `cargo_build_script::toolchains` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L527" href="#L527">527</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-compile_data&quot;&gt;&lt;/a&gt;compile_data |  A list of labels to add to a crate&#39;s `rust_library::compile_data` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L528" href="#L528">528</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-compile_data_glob&quot;&gt;&lt;/a&gt;compile_data_glob |  A list of glob patterns to add to a crate&#39;s `rust_library::compile_data` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L529" href="#L529">529</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-crate_features&quot;&gt;&lt;/a&gt;crate_features |  A list of strings to add to a crate&#39;s `rust_library::crate_features` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L530" href="#L530">530</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-data&quot;&gt;&lt;/a&gt;data |  A list of labels to add to a crate&#39;s `rust_library::data` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L531" href="#L531">531</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-data_glob&quot;&gt;&lt;/a&gt;data_glob |  A list of glob patterns to add to a crate&#39;s `rust_library::data` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L532" href="#L532">532</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-deps&quot;&gt;&lt;/a&gt;deps |  A list of labels to add to a crate&#39;s `rust_library::deps` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L533" href="#L533">533</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-extra_aliased_targets&quot;&gt;&lt;/a&gt;extra_aliased_targets |  A list of targets to add to the generated aliases in the root crate_universe repository.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L534" href="#L534">534</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-gen_binaries&quot;&gt;&lt;/a&gt;gen_binaries |  As a list, the subset of the crate&#39;s bins that should get `rust_binary` targets produced. Or `True` to generate all, `False` to generate none.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L535" href="#L535">535</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-disable_pipelining&quot;&gt;&lt;/a&gt;disable_pipelining |  If True, disables pipelining for library targets for this crate.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L536" href="#L536">536</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-gen_build_script&quot;&gt;&lt;/a&gt;gen_build_script |  An authorative flag to determine whether or not to produce `cargo_build_script` targets for the current crate.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L537" href="#L537">537</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-patch_args&quot;&gt;&lt;/a&gt;patch_args |  The `patch_args` attribute of a Bazel repository rule. See [http_archive.patch_args](https://docs.bazel.build/versions/main/repo/http.html#http_archive-patch_args)   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L538" href="#L538">538</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-patch_tool&quot;&gt;&lt;/a&gt;patch_tool |  The `patch_tool` attribute of a Bazel repository rule. See [http_archive.patch_tool](https://docs.bazel.build/versions/main/repo/http.html#http_archive-patch_tool)   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L539" href="#L539">539</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-patches&quot;&gt;&lt;/a&gt;patches |  The `patches` attribute of a Bazel repository rule. See [http_archive.patches](https://docs.bazel.build/versions/main/repo/http.html#http_archive-patches)   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L540" href="#L540">540</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-proc_macro_deps&quot;&gt;&lt;/a&gt;proc_macro_deps |  A list of labels to add to a crate&#39;s `rust_library::proc_macro_deps` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L541" href="#L541">541</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-rustc_env&quot;&gt;&lt;/a&gt;rustc_env |  Additional variables to set on a crate&#39;s `rust_library::rustc_env` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L542" href="#L542">542</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-rustc_env_files&quot;&gt;&lt;/a&gt;rustc_env_files |  A list of labels to set on a crate&#39;s `rust_library::rustc_env_files` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L543" href="#L543">543</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-rustc_flags&quot;&gt;&lt;/a&gt;rustc_flags |  A list of strings to set on a crate&#39;s `rust_library::rustc_flags` attribute.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L544" href="#L544">544</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-shallow_since&quot;&gt;&lt;/a&gt;shallow_since |  An optional timestamp used for crates originating from a git repository instead of a crate registry. This flag optimizes fetching the source code.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L545" href="#L545">545</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.annotation-override_targets&quot;&gt;&lt;/a&gt;override_targets |  A dictionary of alternate targets to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Keys can be `proc-marco`, `custom-build`, `lib`, `bin`.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L546" href="#L546">546</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L547" href="#L547">547</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="L548" href="#L548">548</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L549" href="#L549">549</a><span class="code-text"><a-p>string: A json encoded string containing the specified version and separately all other inputs.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L550" href="#L550">550</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L551" href="#L551">551</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L552" href="#L552">552</a><span class="code-text"><a-p>&lt;a id=&quot;crate.select&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L553" href="#L553">553</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L554" href="#L554">554</a><span class="code-text"><a-p>## </a-p><a-tt>crate.select</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L555" href="#L555">555</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L556" href="#L556">556</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="L557" href="#L557">557</a><span class="code-text"><a-p>crate.select(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#crate.select-common</a-s><a-p>&quot;&gt;common&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>#crate.select-selects</a-s><a-p>&quot;&gt;selects&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="L558" href="#L558">558</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="L559" href="#L559">559</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L560" href="#L560">560</a><span class="code-text"><a-p>A Starlark Select for `crate.annotation()`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L561" href="#L561">561</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L562" href="#L562">562</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="L563" href="#L563">563</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L564" href="#L564">564</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L565" href="#L565">565</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="L566" href="#L566">566</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L567" href="#L567">567</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.select-common&quot;&gt;&lt;/a&gt;common |  A value that applies to all configurations.   |  none |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L568" href="#L568">568</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.select-selects&quot;&gt;&lt;/a&gt;selects |  A dict of `target_triple` to values.   |  none |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L569" href="#L569">569</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L570" href="#L570">570</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="L571" href="#L571">571</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L572" href="#L572">572</a><span class="code-text"><a-p>struct: A struct representing the Starlark Select.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L573" href="#L573">573</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L574" href="#L574">574</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L575" href="#L575">575</a><span class="code-text"><a-p>&lt;a id=&quot;crate.spec&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L576" href="#L576">576</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L577" href="#L577">577</a><span class="code-text"><a-p>## </a-p><a-tt>crate.spec</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L578" href="#L578">578</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L579" href="#L579">579</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="L580" href="#L580">580</a><span class="code-text"><a-p>crate.spec(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#crate.spec-package</a-s><a-p>&quot;&gt;package&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>#crate.spec-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>#crate.spec-artifact</a-s><a-p>&quot;&gt;artifact&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>#crate.spec-lib</a-s><a-p>&quot;&gt;lib&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>#crate.spec-default_features</a-s><a-p>&quot;&gt;default_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>#crate.spec-features</a-s><a-p>&quot;&gt;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>#crate.spec-git</a-s><a-p>&quot;&gt;git&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>#crate.spec-branch</a-s><a-p>&quot;&gt;branch&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>#crate.spec-tag</a-s><a-p>&quot;&gt;tag&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>#crate.spec-rev</a-s><a-p>&quot;&gt;rev&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="L581" href="#L581">581</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="L582" href="#L582">582</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L583" href="#L583">583</a><span class="code-text"><a-p>A constructor for a crate dependency.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L584" href="#L584">584</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L585" href="#L585">585</a><span class="code-text"><a-p>See [specifying dependencies][sd] in the Cargo book for more details.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L586" href="#L586">586</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L587" href="#L587">587</a><span class="code-text"><a-tu>[sd]</a-tu><a-p>: </a-p><a-tu>https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L588" href="#L588">588</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L589" href="#L589">589</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L590" href="#L590">590</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="L591" href="#L591">591</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L592" href="#L592">592</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L593" href="#L593">593</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="L594" href="#L594">594</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L595" href="#L595">595</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-package&quot;&gt;&lt;/a&gt;package |  The explicit name of the package (used when attempting to alias a crate).   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L596" href="#L596">596</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-version&quot;&gt;&lt;/a&gt;version |  The exact version of the crate. Cannot be used with `git`.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L597" href="#L597">597</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-artifact&quot;&gt;&lt;/a&gt;artifact |  Set to &quot;bin&quot; to pull in a binary crate as an artifact dependency. Requires a nightly Cargo.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L598" href="#L598">598</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-lib&quot;&gt;&lt;/a&gt;lib |  If using `artifact = &quot;bin&quot;`, additionally setting `lib = True` declares a dependency on both the package&#39;s library and binary, as opposed to just the binary.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L599" href="#L599">599</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-default_features&quot;&gt;&lt;/a&gt;default_features |  Maps to the `default-features` flag.   |  `True` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L600" href="#L600">600</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-features&quot;&gt;&lt;/a&gt;features |  A list of features to use for the crate   |  `[]` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L601" href="#L601">601</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-git&quot;&gt;&lt;/a&gt;git |  The Git url to use for the crate. Cannot be used with `version`.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L602" href="#L602">602</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-branch&quot;&gt;&lt;/a&gt;branch |  The git branch of the remote crate. Tied with the `git` param. Only one of branch, tag or rev may be specified. Specifying `rev` is recommended for fully-reproducible builds.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L603" href="#L603">603</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-tag&quot;&gt;&lt;/a&gt;tag |  The git tag of the remote crate. Tied with the `git` param. Only one of branch, tag or rev may be specified. Specifying `rev` is recommended for fully-reproducible builds.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L604" href="#L604">604</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.spec-rev&quot;&gt;&lt;/a&gt;rev |  The git revision of the remote crate. Tied with the `git` param. Only one of branch, tag or rev may be specified.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L605" href="#L605">605</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L606" href="#L606">606</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="L607" href="#L607">607</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L608" href="#L608">608</a><span class="code-text"><a-p>string: A json encoded string of all inputs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L609" href="#L609">609</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L610" href="#L610">610</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L611" href="#L611">611</a><span class="code-text"><a-p>&lt;a id=&quot;crate.workspace_member&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L612" href="#L612">612</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L613" href="#L613">613</a><span class="code-text"><a-p>## </a-p><a-tt>crate.workspace_member</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L614" href="#L614">614</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L615" href="#L615">615</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="L616" href="#L616">616</a><span class="code-text"><a-p>crate.workspace_member(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#crate.workspace_member-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>#crate.workspace_member-sha256</a-s><a-p>&quot;&gt;sha256&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="L617" href="#L617">617</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="L618" href="#L618">618</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L619" href="#L619">619</a><span class="code-text"><a-p>Define information for extra workspace members</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L620" href="#L620">620</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L621" href="#L621">621</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="L622" href="#L622">622</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L623" href="#L623">623</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L624" href="#L624">624</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="L625" href="#L625">625</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L626" href="#L626">626</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.workspace_member-version&quot;&gt;&lt;/a&gt;version |  The semver of the crate to download. Must be an exact version.   |  none |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L627" href="#L627">627</a><span class="code-text"><a-p>| &lt;a id=&quot;crate.workspace_member-sha256&quot;&gt;&lt;/a&gt;sha256 |  The sha256 checksum of the `.crate` file.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L628" href="#L628">628</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L629" href="#L629">629</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="L630" href="#L630">630</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L631" href="#L631">631</a><span class="code-text"><a-p>string: A json encoded string of all inputs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L632" href="#L632">632</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L633" href="#L633">633</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L634" href="#L634">634</a><span class="code-text"><a-p>&lt;a id=&quot;crate_deps&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L635" href="#L635">635</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L636" href="#L636">636</a><span class="code-text"><a-p>## </a-p><a-tt>crate_deps</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L637" href="#L637">637</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L638" href="#L638">638</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="L639" href="#L639">639</a><span class="code-text"><a-p>crate_deps(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#crate_deps-deps</a-s><a-p>&quot;&gt;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>#crate_deps-package_name</a-s><a-p>&quot;&gt;package_name&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="L640" href="#L640">640</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="L641" href="#L641">641</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L642" href="#L642">642</a><span class="code-text"><a-p>Finds the fully qualified label of the requested crates for the package where this macro is called.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L643" href="#L643">643</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L644" href="#L644">644</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="L645" href="#L645">645</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L646" href="#L646">646</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L647" href="#L647">647</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="L648" href="#L648">648</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L649" href="#L649">649</a><span class="code-text"><a-p>| &lt;a id=&quot;crate_deps-deps&quot;&gt;&lt;/a&gt;deps |  The desired list of crate targets.   |  none |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L650" href="#L650">650</a><span class="code-text"><a-p>| &lt;a id=&quot;crate_deps-package_name&quot;&gt;&lt;/a&gt;package_name |  The package name of the set of dependencies to look up. Defaults to `native.package_name()`.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L651" href="#L651">651</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L652" href="#L652">652</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="L653" href="#L653">653</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L654" href="#L654">654</a><span class="code-text"><a-p>list: A list of labels to generated rust targets (str)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L655" href="#L655">655</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L656" href="#L656">656</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L657" href="#L657">657</a><span class="code-text"><a-p>&lt;a id=&quot;crate_repositories&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L658" href="#L658">658</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L659" href="#L659">659</a><span class="code-text"><a-p>## </a-p><a-tt>crate_repositories</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L660" href="#L660">660</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L661" href="#L661">661</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="L662" href="#L662">662</a><span class="code-text"><a-p>crate_repositories()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L663" href="#L663">663</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="L664" href="#L664">664</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L665" href="#L665">665</a><span class="code-text"><a-p>A macro for defining repositories for all generated crates.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L666" href="#L666">666</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L667" href="#L667">667</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L668" href="#L668">668</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="L669" href="#L669">669</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L670" href="#L670">670</a><span class="code-text"><a-p>A list of repos visible to the module through the module extension.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L671" href="#L671">671</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L672" href="#L672">672</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L673" href="#L673">673</a><span class="code-text"><a-p>&lt;a id=&quot;crate_universe_dependencies&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L674" href="#L674">674</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L675" href="#L675">675</a><span class="code-text"><a-p>## </a-p><a-tt>crate_universe_dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L676" href="#L676">676</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L677" href="#L677">677</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="L678" href="#L678">678</a><span class="code-text"><a-p>crate_universe_dependencies(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#crate_universe_dependencies-rust_version</a-s><a-p>&quot;&gt;rust_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>#crate_universe_dependencies-bootstrap</a-s><a-p>&quot;&gt;bootstrap&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>#crate_universe_dependencies-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="L679" href="#L679">679</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="L680" href="#L680">680</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L681" href="#L681">681</a><span class="code-text"><a-p>Define dependencies of the `cargo-bazel` Rust target</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L682" href="#L682">682</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L683" href="#L683">683</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="L684" href="#L684">684</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L685" href="#L685">685</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L686" href="#L686">686</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="L687" href="#L687">687</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L688" href="#L688">688</a><span class="code-text"><a-p>| &lt;a id=&quot;crate_universe_dependencies-rust_version&quot;&gt;&lt;/a&gt;rust_version |  The version of rust to use when generating dependencies.   |  `&quot;1.83.0&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L689" href="#L689">689</a><span class="code-text"><a-p>| &lt;a id=&quot;crate_universe_dependencies-bootstrap&quot;&gt;&lt;/a&gt;bootstrap |  If true, a `cargo_bootstrap_repository` target will be generated.   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L690" href="#L690">690</a><span class="code-text"><a-p>| &lt;a id=&quot;crate_universe_dependencies-kwargs&quot;&gt;&lt;/a&gt;kwargs |  Arguments to pass through to cargo_bazel_bootstrap.   |  none |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L691" href="#L691">691</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L692" href="#L692">692</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="L693" href="#L693">693</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L694" href="#L694">694</a><span class="code-text"><a-p>list[struct(repo=str, is_dev_dep=bool)]: A list of the repositories</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L695" href="#L695">695</a><span class="code-text"><a-p>  defined by this macro.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L696" href="#L696">696</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L697" href="#L697">697</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L698" href="#L698">698</a><span class="code-text"><a-p>&lt;a id=&quot;render_config&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L699" href="#L699">699</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L700" href="#L700">700</a><span class="code-text"><a-p>## </a-p><a-tt>render_config</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L701" href="#L701">701</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L702" href="#L702">702</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="L703" href="#L703">703</a><span class="code-text"><a-p>render_config(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#render_config-build_file_template</a-s><a-p>&quot;&gt;build_file_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>#render_config-crate_label_template</a-s><a-p>&quot;&gt;crate_label_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>#render_config-crate_repository_template</a-s><a-p>&quot;&gt;crate_repository_template&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="L704" href="#L704">704</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>#render_config-crates_module_template</a-s><a-p>&quot;&gt;crates_module_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>#render_config-default_alias_rule</a-s><a-p>&quot;&gt;default_alias_rule&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>#render_config-default_package_name</a-s><a-p>&quot;&gt;default_package_name&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="L705" href="#L705">705</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>#render_config-generate_target_compatible_with</a-s><a-p>&quot;&gt;generate_target_compatible_with&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>#render_config-platforms_template</a-s><a-p>&quot;&gt;platforms_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>#render_config-regen_command</a-s><a-p>&quot;&gt;regen_command&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>#render_config-vendor_mode</a-s><a-p>&quot;&gt;vendor_mode&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="L706" href="#L706">706</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>#render_config-generate_rules_license_metadata</a-s><a-p>&quot;&gt;generate_rules_license_metadata&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="L707" href="#L707">707</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="L708" href="#L708">708</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L709" href="#L709">709</a><span class="code-text"><a-p>Various settings used to configure rendered outputs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L710" href="#L710">710</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L711" href="#L711">711</a><span class="code-text"><a-p>The template parameters each support a select number of format keys. A description of each key</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L712" href="#L712">712</a><span class="code-text"><a-p>can be found below where the supported keys for each template can be found in the parameter docs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L713" href="#L713">713</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L714" href="#L714">714</a><span class="code-text"><a-p>| key | definition |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L715" href="#L715">715</a><span class="code-text"><a-p>| --- | --- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L716" href="#L716">716</a><span class="code-text"><a-p>| `name` | The name of the crate. Eg `tokio` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L717" href="#L717">717</a><span class="code-text"><a-p>| `repository` | The rendered repository name for the crate. Directly relates to `crate_repository_template`. |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L718" href="#L718">718</a><span class="code-text"><a-p>| `triple` | A platform triple. Eg `x86_64-unknown-linux-gnu` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L719" href="#L719">719</a><span class="code-text"><a-p>| `version` | The crate version. Eg `1.2.3` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L720" href="#L720">720</a><span class="code-text"><a-p>| `target` | The library or binary target of the crate |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L721" href="#L721">721</a><span class="code-text"><a-p>| `file` | The basename of a file |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L722" href="#L722">722</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L723" href="#L723">723</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L724" href="#L724">724</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="L725" href="#L725">725</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L726" href="#L726">726</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L727" href="#L727">727</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="L728" href="#L728">728</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L729" href="#L729">729</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-build_file_template&quot;&gt;&lt;/a&gt;build_file_template |  The base template to use for BUILD file names. The available format keys are [`{name}`, {version}`].   |  `&quot;//:BUILD.{name}-{version}.bazel&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L730" href="#L730">730</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-crate_label_template&quot;&gt;&lt;/a&gt;crate_label_template |  The base template to use for crate labels. The available format keys are [`{repository}`, `{name}`, `{version}`, `{target}`].   |  `&quot;@{repository}__{name}-{version}//:{target}&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L731" href="#L731">731</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-crate_repository_template&quot;&gt;&lt;/a&gt;crate_repository_template |  The base template to use for Crate label repository names. The available format keys are [`{repository}`, `{name}`, `{version}`].   |  `&quot;{repository}__{name}-{version}&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L732" href="#L732">732</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-crates_module_template&quot;&gt;&lt;/a&gt;crates_module_template |  The pattern to use for the `defs.bzl` and `BUILD.bazel` file names used for the crates module. The available format keys are [`{file}`].   |  `&quot;//:{file}&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L733" href="#L733">733</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-default_alias_rule&quot;&gt;&lt;/a&gt;default_alias_rule |  Alias rule to use when generating aliases for all crates.  Acceptable values are &#39;alias&#39;, &#39;dbg&#39;/&#39;fastbuild&#39;/&#39;opt&#39; (transitions each crate&#39;s `compilation_mode`)  or a string representing a rule in the form &#39;&lt;label to .bzl&gt;:&lt;rule&gt;&#39; that takes a single label parameter &#39;actual&#39;. See &#39;@crate_index//:alias_rules.bzl&#39; for an example.   |  `&quot;alias&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L734" href="#L734">734</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-default_package_name&quot;&gt;&lt;/a&gt;default_package_name |  The default package name to use in the rendered macros. This affects the auto package detection of things like `all_crate_deps`.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L735" href="#L735">735</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-generate_target_compatible_with&quot;&gt;&lt;/a&gt;generate_target_compatible_with |  Whether to generate `target_compatible_with` annotations on the generated BUILD files.  This catches a `target_triple`being targeted that isn&#39;t declared in `supported_platform_triples`.   |  `True` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L736" href="#L736">736</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-platforms_template&quot;&gt;&lt;/a&gt;platforms_template |  The base template to use for platform names. See [platforms documentation](https://docs.bazel.build/versions/main/platforms.html). The available format keys are [`{triple}`].   |  `&quot;@rules_rust//rust/platform:{triple}&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L737" href="#L737">737</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-regen_command&quot;&gt;&lt;/a&gt;regen_command |  An optional command to demonstrate how generated files should be regenerated.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L738" href="#L738">738</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-vendor_mode&quot;&gt;&lt;/a&gt;vendor_mode |  An optional configuration for rendirng content to be rendered into repositories.   |  `None` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L739" href="#L739">739</a><span class="code-text"><a-p>| &lt;a id=&quot;render_config-generate_rules_license_metadata&quot;&gt;&lt;/a&gt;generate_rules_license_metadata |  Whether to generate rules license metedata   |  `False` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L740" href="#L740">740</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L741" href="#L741">741</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="L742" href="#L742">742</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L743" href="#L743">743</a><span class="code-text"><a-p>string: A json encoded struct to match the Rust `config::RenderConfig` struct</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L744" href="#L744">744</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L745" href="#L745">745</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L746" href="#L746">746</a><span class="code-text"><a-p>&lt;a id=&quot;splicing_config&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L747" href="#L747">747</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L748" href="#L748">748</a><span class="code-text"><a-p>## </a-p><a-tt>splicing_config</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L749" href="#L749">749</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L750" href="#L750">750</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="L751" href="#L751">751</a><span class="code-text"><a-p>splicing_config(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#splicing_config-resolver_version</a-s><a-p>&quot;&gt;resolver_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="L752" href="#L752">752</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="L753" href="#L753">753</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L754" href="#L754">754</a><span class="code-text"><a-p>Various settings used to configure Cargo manifest splicing behavior.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L755" href="#L755">755</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L756" href="#L756">756</a><span class="code-text"><a-tu>[rv]</a-tu><a-p>: </a-p><a-tu>https://doc.rust-lang.org/cargo/reference/resolver.html#resolver-versions</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L757" href="#L757">757</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L758" href="#L758">758</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L759" href="#L759">759</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="L760" href="#L760">760</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L761" href="#L761">761</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L762" href="#L762">762</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="L763" href="#L763">763</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L764" href="#L764">764</a><span class="code-text"><a-p>| &lt;a id=&quot;splicing_config-resolver_version&quot;&gt;&lt;/a&gt;resolver_version |  The [resolver version][rv] to use in generated Cargo manifests. This flag is **only** used when splicing a manifest from direct package definitions. See `crates_repository::packages`.   |  `&quot;2&quot;` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L765" href="#L765">765</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L766" href="#L766">766</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="L767" href="#L767">767</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L768" href="#L768">768</a><span class="code-text"><a-p>str: A json encoded string of the parameters provided</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L769" href="#L769">769</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L770" href="#L770">770</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L771" href="#L771">771</a><span class="code-text"><a-p>&lt;a id=&quot;crates_repository&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L772" href="#L772">772</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L773" href="#L773">773</a><span class="code-text"><a-p>## </a-p><a-tt>crates_repository</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L774" href="#L774">774</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L775" href="#L775">775</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="L776" href="#L776">776</a><span class="code-text"><a-p>crates_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>#crates_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>#crates_repository-annotations</a-s><a-p>&quot;&gt;annotations&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>#crates_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>#crates_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>#crates_repository-generate_binaries</a-s><a-p>&quot;&gt;generate_binaries&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="L777" href="#L777">777</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>#crates_repository-generate_build_scripts</a-s><a-p>&quot;&gt;generate_build_scripts&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>#crates_repository-generate_target_compatible_with</a-s><a-p>&quot;&gt;generate_target_compatible_with&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>#crates_repository-generator</a-s><a-p>&quot;&gt;generator&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="L778" href="#L778">778</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>#crates_repository-generator_sha256s</a-s><a-p>&quot;&gt;generator_sha256s&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>#crates_repository-generator_urls</a-s><a-p>&quot;&gt;generator_urls&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>#crates_repository-isolated</a-s><a-p>&quot;&gt;isolated&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>#crates_repository-lockfile</a-s><a-p>&quot;&gt;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>#crates_repository-manifests</a-s><a-p>&quot;&gt;manifests&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>#crates_repository-packages</a-s><a-p>&quot;&gt;packages&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>#crates_repository-quiet</a-s><a-p>&quot;&gt;quiet&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="L779" href="#L779">779</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>#crates_repository-render_config</a-s><a-p>&quot;&gt;render_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>#crates_repository-repin_instructions</a-s><a-p>&quot;&gt;repin_instructions&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>#crates_repository-repo_mapping</a-s><a-p>&quot;&gt;repo_mapping&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>#crates_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;,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L780" href="#L780">780</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>#crates_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>#crates_repository-rust_version</a-s><a-p>&quot;&gt;rust_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>#crates_repository-splicing_config</a-s><a-p>&quot;&gt;splicing_config&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="L781" href="#L781">781</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>#crates_repository-supported_platform_triples</a-s><a-p>&quot;&gt;supported_platform_triples&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="L782" href="#L782">782</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="L783" href="#L783">783</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L784" href="#L784">784</a><span class="code-text"><a-p>A rule for defining and downloading Rust dependencies (crates). This rule</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L785" href="#L785">785</a><span class="code-text"><a-p>handles all the same [workflows](#workflows) `crate_universe` rules do.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L786" href="#L786">786</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L787" href="#L787">787</a><span class="code-text"><a-p>Environment Variables:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L788" href="#L788">788</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L789" href="#L789">789</a><span class="code-text"><a-p>| variable | usage |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L790" href="#L790">790</a><span class="code-text"><a-p>| --- | --- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L791" href="#L791">791</a><span class="code-text"><a-p>| `CARGO_BAZEL_GENERATOR_SHA256` | The sha256 checksum of the file located at `CARGO_BAZEL_GENERATOR_URL` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L792" href="#L792">792</a><span class="code-text"><a-p>| `CARGO_BAZEL_GENERATOR_URL` | The URL of a cargo-bazel binary. This variable takes precedence over attributes and can use `file://` for local paths |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L793" href="#L793">793</a><span class="code-text"><a-p>| `CARGO_BAZEL_ISOLATED` | An authorative flag as to whether or not the `CARGO_HOME` environment variable should be isolated from the host configuration |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L794" href="#L794">794</a><span class="code-text"><a-p>| `CARGO_BAZEL_REPIN` | An indicator that the dependencies represented by the rule should be regenerated. `REPIN` may also be used. See [Repinning / Updating Dependencies](#repinning--updating-dependencies) for more details. |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L795" href="#L795">795</a><span class="code-text"><a-p>| `CARGO_BAZEL_REPIN_ONLY` | A comma-delimited allowlist for rules to execute repinning. Can be useful if multiple instances of the repository rule are used in a Bazel workspace, but repinning should be limited to one of them. |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L796" href="#L796">796</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L797" href="#L797">797</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="L798" href="#L798">798</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L799" href="#L799">799</a><span class="code-text"><a-p>Given the following workspace structure:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L800" href="#L800">800</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L801" href="#L801">801</a><span class="code-text"><a-p>```</a-p><a-tl>text</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L802" href="#L802">802</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="L803" href="#L803">803</a><span class="code-text"><a-p>    WORKSPACE.bazel</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L804" href="#L804">804</a><span class="code-text"><a-p>    BUILD.bazel</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L805" href="#L805">805</a><span class="code-text"><a-p>    Cargo.toml</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L806" href="#L806">806</a><span class="code-text"><a-p>    Cargo.Bazel.lock</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L807" href="#L807">807</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="L808" href="#L808">808</a><span class="code-text"><a-p>        main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L809" href="#L809">809</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L810" href="#L810">810</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L811" href="#L811">811</a><span class="code-text"><a-p>The following is something that&#39;d be found in the `WORKSPACE` file:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L812" href="#L812">812</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L813" href="#L813">813</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="L814" href="#L814">814</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//crate_universe:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crates_repository&quot;</a-s><a-p>, </a-p><a-s>&quot;crate&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L815" href="#L815">815</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L816" href="#L816">816</a><span class="code-text"><a-p>crates_repository(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L817" href="#L817">817</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;crate_index&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L818" href="#L818">818</a><span class="code-text"><a-p>    </a-p><a-v>annotations</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="L819" href="#L819">819</a><span class="code-text"><a-p>        </a-p><a-s>&quot;rand&quot;</a-s><a-p>: [</a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>annotation</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L820" href="#L820">820</a><span class="code-text"><a-p>            </a-p><a-v>default_features</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-co>False</a-co><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L821" href="#L821">821</a><span class="code-text"><a-p>            </a-p><a-v>features</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;small_rng&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L822" href="#L822">822</a><span class="code-text"><a-p>        )],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L823" href="#L823">823</a><span class="code-text"><a-p>    },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L824" href="#L824">824</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.Bazel.lock&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L825" href="#L825">825</a><span class="code-text"><a-p>    </a-p><a-v>lockfile</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//:cargo-bazel-lock.json&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L826" href="#L826">826</a><span class="code-text"><a-p>    </a-p><a-v>manifests</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="L827" href="#L827">827</a><span class="code-text"><a-p>    </a-p><a-c># Should match the version represented by the currently registered `rust_toolchain`.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L828" href="#L828">828</a><span class="code-text"><a-p>    </a-p><a-v>rust_version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;1.60.0&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L829" href="#L829">829</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L830" href="#L830">830</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L831" href="#L831">831</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L832" href="#L832">832</a><span class="code-text"><a-p>The above will create an external repository which contains aliases and macros for accessing</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L833" href="#L833">833</a><span class="code-text"><a-p>Rust targets found in the dependency graph defined by the given manifests.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L834" href="#L834">834</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L835" href="#L835">835</a><span class="code-text"><a-p>**NOTE**: The `cargo_lockfile` and `lockfile` must be manually created. The rule unfortunately does not yet create</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L836" href="#L836">836</a><span class="code-text"><a-p>it on its own. When initially setting up this rule, an empty file should be created and then</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L837" href="#L837">837</a><span class="code-text"><a-p>populated by repinning dependencies.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L838" href="#L838">838</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L839" href="#L839">839</a><span class="code-text"><a-p>### </a-p><a-tt>Repinning / Updating Dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L840" href="#L840">840</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L841" href="#L841">841</a><span class="code-text"><a-p>Dependency syncing and updating is done in the repository rule which means it&#39;s done during the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L842" href="#L842">842</a><span class="code-text"><a-p>analysis phase of builds. As mentioned in the environments variable table above, the `CARGO_BAZEL_REPIN`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L843" href="#L843">843</a><span class="code-text"><a-p>(or `REPIN`) environment variables can be used to force the rule to update dependencies and potentially</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L844" href="#L844">844</a><span class="code-text"><a-p>render a new lockfile. Given an instance of this repository rule named `crate_index`, the easiest way to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L845" href="#L845">845</a><span class="code-text"><a-p>repin dependencies is to run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L846" href="#L846">846</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L847" href="#L847">847</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L848" href="#L848">848</a><span class="code-text"><a-p>CARGO_BAZEL_REPIN=1 bazel sync --only=crate_index</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L849" href="#L849">849</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L850" href="#L850">850</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L851" href="#L851">851</a><span class="code-text"><a-p>This will result in all dependencies being updated for a project. The `CARGO_BAZEL_REPIN` environment variable</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L852" href="#L852">852</a><span class="code-text"><a-p>can also be used to customize how dependencies are updated. The following table shows translations from environment</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L853" href="#L853">853</a><span class="code-text"><a-p>variable values to the equivilant [cargo update](https://doc.rust-lang.org/cargo/commands/cargo-update.html) command</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L854" href="#L854">854</a><span class="code-text"><a-p>that is called behind the scenes to update dependencies.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L855" href="#L855">855</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L856" href="#L856">856</a><span class="code-text"><a-p>| Value | Cargo command |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L857" href="#L857">857</a><span class="code-text"><a-p>| --- | --- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L858" href="#L858">858</a><span class="code-text"><a-p>| Any of [`true`, `1`, `yes`, `on`, `workspace`] | `cargo update --workspace` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L859" href="#L859">859</a><span class="code-text"><a-p>| Any of [`full`, `eager`, `all`] | `cargo update` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L860" href="#L860">860</a><span class="code-text"><a-p>| `package_name` | `cargo upgrade --package package_name` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L861" href="#L861">861</a><span class="code-text"><a-p>| `package_name@1.2.3` | `cargo upgrade --package package_name@1.2.3` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L862" href="#L862">862</a><span class="code-text"><a-p>| `package_name@1.2.3=4.5.6` | `cargo upgrade --package package_name@1.2.3 --precise=4.5.6` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L863" href="#L863">863</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L864" href="#L864">864</a><span class="code-text"><a-p>If the `crates_repository` is used multiple times in the same Bazel workspace (e.g. for multiple independent</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L865" href="#L865">865</a><span class="code-text"><a-p>Rust workspaces), it may additionally be useful to use the `CARGO_BAZEL_REPIN_ONLY` environment variable, which</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L866" href="#L866">866</a><span class="code-text"><a-p>limits execution of the repinning to one or multiple instances of the `crates_repository` rule via a comma-delimited</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L867" href="#L867">867</a><span class="code-text"><a-p>allowlist:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L868" href="#L868">868</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L869" href="#L869">869</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L870" href="#L870">870</a><span class="code-text"><a-p>CARGO_BAZEL_REPIN=1 CARGO_BAZEL_REPIN_ONLY=crate_index bazel sync --only=crate_index</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L871" href="#L871">871</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L872" href="#L872">872</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L873" href="#L873">873</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="L874" href="#L874">874</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L875" href="#L875">875</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L876" href="#L876">876</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="L877" href="#L877">877</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L878" href="#L878">878</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_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 |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L879" href="#L879">879</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-annotations&quot;&gt;&lt;/a&gt;annotations |  Extra settings to apply to crates. See [crate.annotation](#crateannotation).   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; List of strings&lt;/a&gt; | optional |  `{}`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L880" href="#L880">880</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-cargo_config&quot;&gt;&lt;/a&gt;cargo_config |  A [Cargo configuration](https://doc.rust-lang.org/cargo/reference/config.html) file   | &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="L881" href="#L881">881</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-cargo_lockfile&quot;&gt;&lt;/a&gt;cargo_lockfile |  The path used to store the `crates_repository` specific [Cargo.lock](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html) file. In the case that your `crates_repository` corresponds directly with an existing `Cargo.toml` file which has a paired `Cargo.lock` file, that `Cargo.lock` file should be used here, which will keep the versions used by cargo and bazel in sync.   | &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="L882" href="#L882">882</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-generate_binaries&quot;&gt;&lt;/a&gt;generate_binaries |  Whether to generate `rust_binary` targets for all the binary crates in every package. By default only the `rust_library` targets are generated.   | Boolean | optional |  `False`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L883" href="#L883">883</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-generate_build_scripts&quot;&gt;&lt;/a&gt;generate_build_scripts |  Whether or not to generate [cargo build scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html) by default.   | Boolean | optional |  `True`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L884" href="#L884">884</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-generate_target_compatible_with&quot;&gt;&lt;/a&gt;generate_target_compatible_with |  DEPRECATED: Moved to `render_config`.   | Boolean | optional |  `True`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L885" href="#L885">885</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-generator&quot;&gt;&lt;/a&gt;generator |  The absolute label of a generator. Eg. `@cargo_bazel_bootstrap//:cargo-bazel`. This is typically used when bootstrapping   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L886" href="#L886">886</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-generator_sha256s&quot;&gt;&lt;/a&gt;generator_sha256s |  Dictionary of `host_triple` -&gt; `sha256` for a `cargo-bazel` binary.   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; String&lt;/a&gt; | optional |  `{}`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L887" href="#L887">887</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-generator_urls&quot;&gt;&lt;/a&gt;generator_urls |  URL template from which to download the `cargo-bazel` binary. `{host_triple}` and will be filled in according to the host platform.   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; String&lt;/a&gt; | optional |  `{}`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L888" href="#L888">888</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-isolated&quot;&gt;&lt;/a&gt;isolated |  If true, `CARGO_HOME` will be overwritten to a directory within the generated repository in order to prevent other uses of Cargo from impacting having any effect on the generated targets produced by this rule. For users who either have multiple `crate_repository` definitions in a WORKSPACE or rapidly re-pin dependencies, setting this to false may improve build times. This variable is also controled by `CARGO_BAZEL_ISOLATED` environment variable.   | Boolean | optional |  `True`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L889" href="#L889">889</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-lockfile&quot;&gt;&lt;/a&gt;lockfile |  The path to a file to use for reproducible renderings. If set, this file must exist within the workspace (but can be empty) before this rule will work.   | &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="L890" href="#L890">890</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-manifests&quot;&gt;&lt;/a&gt;manifests |  A list of Cargo manifests (`Cargo.toml` files).   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | optional |  `[]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L891" href="#L891">891</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-packages&quot;&gt;&lt;/a&gt;packages |  A set of crates (packages) specifications to depend on. See [crate.spec](#crate.spec).   | &lt;a href=&quot;https://bazel.build/rules/lib/dict&quot;&gt;Dictionary: String -&gt; String&lt;/a&gt; | optional |  `{}`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L892" href="#L892">892</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-quiet&quot;&gt;&lt;/a&gt;quiet |  If stdout and stderr should not be printed to the terminal.   | Boolean | optional |  `True`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L893" href="#L893">893</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-render_config&quot;&gt;&lt;/a&gt;render_config |  The configuration flags to use for rendering. Use `//crate_universe:defs.bzl\%render_config` to generate the value for this field. If unset, the defaults defined there will be used.   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L894" href="#L894">894</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-repin_instructions&quot;&gt;&lt;/a&gt;repin_instructions |  Instructions to re-pin the repository if required. Many people have wrapper scripts for keeping dependencies up to date, and would like to point users to that instead of the default.   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L895" href="#L895">895</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_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 |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L896" href="#L896">896</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_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;), `{cfg}` (eg. &#39;exec&#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;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L897" href="#L897">897</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_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;), `{cfg}` (eg. &#39;exec&#39;), `{channel}` (eg. &#39;stable&#39;), and `{tool}` (eg. &#39;cargo.exe&#39;) will be replaced in the string if present.   | String | optional |  `&quot;@rust_{system}_{arch}__{triple}__{channel}_tools//:bin/{tool}&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L898" href="#L898">898</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-rust_version&quot;&gt;&lt;/a&gt;rust_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;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L899" href="#L899">899</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-splicing_config&quot;&gt;&lt;/a&gt;splicing_config |  The configuration flags to use for splicing Cargo maniests. Use `//crate_universe:defs.bzl\%rsplicing_config` to generate the value for this field. If unset, the defaults defined there will be used.   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L900" href="#L900">900</a><span class="code-text"><a-p>| &lt;a id=&quot;crates_repository-supported_platform_triples&quot;&gt;&lt;/a&gt;supported_platform_triples |  A set of all platform triples to consider when generating dependencies.   | List of strings | optional |  `[&quot;aarch64-apple-darwin&quot;, &quot;aarch64-apple-ios&quot;, &quot;aarch64-apple-ios-sim&quot;, &quot;aarch64-linux-android&quot;, &quot;aarch64-pc-windows-msvc&quot;, &quot;aarch64-unknown-fuchsia&quot;, &quot;aarch64-unknown-linux-gnu&quot;, &quot;aarch64-unknown-nixos-gnu&quot;, &quot;aarch64-unknown-nto-qnx710&quot;, &quot;arm-unknown-linux-gnueabi&quot;, &quot;armv7-linux-androideabi&quot;, &quot;armv7-unknown-linux-gnueabi&quot;, &quot;i686-apple-darwin&quot;, &quot;i686-linux-android&quot;, &quot;i686-pc-windows-msvc&quot;, &quot;i686-unknown-freebsd&quot;, &quot;i686-unknown-linux-gnu&quot;, &quot;powerpc-unknown-linux-gnu&quot;, &quot;riscv32imc-unknown-none-elf&quot;, &quot;riscv64gc-unknown-none-elf&quot;, &quot;s390x-unknown-linux-gnu&quot;, &quot;thumbv7em-none-eabi&quot;, &quot;thumbv8m.main-none-eabi&quot;, &quot;wasm32-unknown-unknown&quot;, &quot;wasm32-wasip1&quot;, &quot;x86_64-apple-darwin&quot;, &quot;x86_64-apple-ios&quot;, &quot;x86_64-linux-android&quot;, &quot;x86_64-pc-windows-msvc&quot;, &quot;x86_64-unknown-freebsd&quot;, &quot;x86_64-unknown-fuchsia&quot;, &quot;x86_64-unknown-linux-gnu&quot;, &quot;x86_64-unknown-nixos-gnu&quot;, &quot;x86_64-unknown-none&quot;]`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L901" href="#L901">901</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L902" href="#L902">902</a><span class="code-text"><a-p>**ENVIRONMENT VARIABLES**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L903" href="#L903">903</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L904" href="#L904">904</a><span class="code-text"><a-p>This repository rule depends on the following environment variables:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L905" href="#L905">905</a><span class="code-text"><a-p>* `CARGO_BAZEL_GENERATOR_URL`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L906" href="#L906">906</a><span class="code-text"><a-p>* `CARGO_BAZEL_GENERATOR_SHA256`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L907" href="#L907">907</a><span class="code-text"><a-p>* `CARGO_BAZEL_REPIN`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L908" href="#L908">908</a><span class="code-text"><a-p>* `REPIN`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L909" href="#L909">909</a><span class="code-text"><a-p>* `CARGO_BAZEL_REPIN_ONLY`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L910" href="#L910">910</a><span class="code-text"><a-p>* `CARGO_BAZEL_ISOLATED`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L911" href="#L911">911</a><span class="code-text"><a-p>* </a-p>`CARGO_BAZEL_DEBUG`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L912" href="#L912">912</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L913" href="#L913">913</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
