<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/index.md - fork/rules_rust @ rust-analyzer</title>
<meta name="description" content="docs/index.md in fork/rules_rust at rust-analyzer.">
<meta property="og:title" content="docs/index.md - fork/rules_rust @ rust-analyzer">
<meta property="og:description" content="docs/index.md in fork/rules_rust at rust-analyzer.">
<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="rust-analyzer" data-tip="d8ea6b8c806c8581efd1e7cbdaadcf037aba2310">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">UebelAndre</span><span class="commit-message" data-commit="9adfdca9bc0fb846913293b5f5927f360022db36">Various cleanups (#1828)</span><span class="snapshot-sha sha" data-commit="9adfdca9bc0fb846913293b5f5927f360022db36">9adfdca9</span><time datetime="2023-02-09T07:27:47-08:00" title="2023-02-09 07:27:47 -0800">2023-02-09</time></p>
<header class="topbar"><details class="switcher"><summary>rust-analyzer</summary><div class="menu"><strong>branches</strong><a href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a class="current" 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/rust-analyzer/tree/docs/">docs</a> / <span class="cur">index.md</span></nav>
<span class="view-stats"><span>4.5 KiB</span><span>106 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/78fdd1d5ca5d95dc6e2f9088e3157d01039cb62d/docs/index.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"><h1><a href="https://github.com/bazelbuild/rules_rust">Rules rust</a></h1>
<h2>Overview</h2>
<p>This repository provides rules for building <a href="http://www.rust-lang.org/">Rust</a> projects with <a href="https://bazel.build/">Bazel</a>.</p>
&lt;!-- TODO: Render generated docs on the github pages site again, https://bazelbuild.github.io/rules_rust/ --&gt;
<p>&lt;a name="setup"&gt;&lt;/a&gt;</p>
<h2>Setup</h2>
<p>To use the Rust rules, add the following to your <code>WORKSPACE</code> file to add the external repositories for the Rust toolchain:</p>
<pre class="language-python"><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-c># To find additional information on this release or newer ones visit:</a-c>
<a-c># https://github.com/bazelbuild/rules_rust/releases</a-c>
<a-f>http_archive</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rules_rust&quot;</a-s>,
    <a-v>sha256</a-v> <a-o>=</a-o> <a-s>&quot;37f40490169dc94013c7566c75c861977a2c02ce5505b7e975da0f7d5f2231c8&quot;</a-s>,
    <a-v>urls</a-v> <a-o>=</a-o> [<a-s>&quot;https://github.com/bazelbuild/rules_rust/releases/download/0.16.1/rules_rust-v0.16.1.tar.gz&quot;</a-s>],
)

<a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:repositories.bzl&quot;</a-s>, <a-s>&quot;rules_rust_dependencies&quot;</a-s>, <a-s>&quot;rust_register_toolchains&quot;</a-s>)

<a-f>rules_rust_dependencies</a-f>()

<a-f>rust_register_toolchains</a-f>()</pre>
<p>The rules are released, and releases can be found on <a href="https://github.com/bazelbuild/rules_rust/releases">the GitHub Releases page</a>. We recommend using the latest release from that page.</p>
<h2>Rules</h2>
<ul>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/defs.md">defs</a>: standard rust rules for building and testing libraries and binaries.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/rust_doc.md">rust_doc</a>: rules for generating and testing rust documentation.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/rust_clippy.md">rust_clippy</a>: rules for running <a href="https://github.com/rust-lang/rust-clippy#readme">clippy</a>.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/rust_fmt.md">rust_fmt</a>: rules for running <a href="https://github.com/rust-lang/rustfmt#readme">rustfmt</a>.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/rust_proto.md">rust_proto</a>: rules for generating <a href="https://developers.google.com/protocol-buffers">protobuf</a> and <a href="https://grpc.io">gRPC</a> stubs.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/rust_bindgen.md">rust_bindgen</a>: rules for generating C++ bindings.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/rust_wasm_bindgen.md">rust_wasm_bindgen</a>: rules for generating <a href="https://www.rust-lang.org/what/wasm">WebAssembly</a> bindings.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/cargo.md">cargo</a>: Rules dedicated to Cargo compatibility. ie: <a href="https://doc.rust-lang.org/cargo/reference/build-scripts.html"><code>build.rs</code> scripts</a>.</li>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/crate_universe.md">crate_universe</a>: Rules for generating Bazel targets for external crate dependencies.</li>
</ul>
<p>You can also browse the <a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/flatten.md">full API in one page</a>.</p>
<h3>Experimental rules</h3>
<ul>
<li><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/rust_analyzer.md">rust_analyzer</a>: rules for generating <code>rust-project.json</code> files for <a href="https://rust-analyzer.github.io/">rust-analyzer</a></li>
</ul>
<h2>Specifying Rust version</h2>
<p>To build with a particular version of the Rust compiler, pass that version to <a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/flatten.md#rust_register_toolchains"><code>rust_register_toolchains</code></a>:</p>
<pre class="language-python"><a-f>rust_register_toolchains</a-f>(
    <a-v>edition</a-v> <a-o>=</a-o> <a-s>&quot;2021&quot;</a-s>,
    <a-v>versions</a-v> <a-o>=</a-o> [
        <a-s>&quot;1.66.1&quot;</a-s>
    ],
)</pre>
<p>As well as an exact version, <code>versions</code> can accept <code>nightly/{iso_date}</code> and <code>beta/{iso_date}</code> strings for toolchains from different release channels.</p>
<pre class="language-python"><a-f>rust_register_toolchains</a-f>(
    <a-v>edition</a-v> <a-o>=</a-o> <a-s>&quot;2021&quot;</a-s>
    <a-v>versions</a-v> <a-o>=</a-o> [
        <a-s>&quot;nightly/2022-12-15&quot;</a-s>,
    ],
)</pre>
<p>By default, a <code>stable</code> and <code>nightly</code> toolchain will be registered if no versions are passed to <code>rust_register_toolchains</code>. However,
if only 1 version is passed and it is from the <code>nightly</code> or <code>beta</code> release channels (i.e. <strong>not</strong> <code>stable</code>), then a build setting must
also be set in the project's <code>.bazelrc</code> file.</p>
<pre>build --@rules_rust//rust/toolchain/channel=nightly
</pre>
<p>Failure to do so will result in rules attempting to match a <code>stable</code> toolchain when one was not registered.</p>
<h2>External Dependencies</h2>
<p><a href="/fork/rules_rust/ref/rust-analyzer/blob/docs/crate_universe.md">crate_universe</a> is a tool built into <code>rules_rust</code> that can be used to fetch dependencies. Additionally, <a href="https://github.com/google/cargo-raze">cargo-raze</a> is an older third-party which can also fetch dependencies.</p>
<h2>Supported bazel versions</h2>
<p>The oldest version of Bazel the <code>main</code> branch is tested against is <code>5.0.0</code>. Previous versions may still be functional in certain environments, but this is the minimum version we strive to fully support.</p>
<p>We test these rules against the latest rolling releases of Bazel, and aim for compatibility with them, but prioritise stable releases over rolling releases where necessary.</p>
<h2>Supported platforms</h2>
<p>We aim to support Linux, macOS, and Windows.</p>
<p>Windows support is less complete than the other two platforms, but most things work, and we welcome contributions to help improve its support.</p>
<p>Windows support for some features requires <code>--enable_runfiles</code> to be passed to Bazel, we recommend putting it in your bazelrc. See <a href="https://bazel.build/configure/windows">Using Bazel on Windows</a> for more Windows-specific recommendations.</p>
</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-p>#</a-p> <a-tt>[Rules rust](https://github.com/bazelbuild/rules_rust)</a-tt></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>Overview</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">This repository provides rules for building [Rust][rust] projects with [Bazel][bazel].</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"><a-tu>[bazel]</a-tu>: <a-tu>https://bazel.build/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-tu>[rust]</a-tu>: <a-tu>http://www.rust-lang.org/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-c>&lt;!-- TODO: Render generated docs on the github pages site again, https://bazelbuild.github.io/rules_rust/ --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">&lt;a name=&quot;setup&quot;&gt;&lt;/a&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>##</a-p> <a-tt>Setup</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">To use the Rust rules, add the following to your `WORKSPACE` file to add the external repositories for the Rust toolchain:</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>```</a-p><a-tl>python</a-tl></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>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="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># To find additional information on this release or newer ones visit:</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># https://github.com/bazelbuild/rules_rust/releases</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>http_archive(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rules_rust&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>    </a-p><a-v>sha256</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;37f40490169dc94013c7566c75c861977a2c02ce5505b7e975da0f7d5f2231c8&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>    </a-p><a-v>urls</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;https://github.com/bazelbuild/rules_rust/releases/download/0.16.1/rules_rust-v0.16.1.tar.gz&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>)</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//rust:repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rules_rust_dependencies&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_register_toolchains&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>rules_rust_dependencies()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>rust_register_toolchains()</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>```</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"></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>The rules are released, and releases can be found on [the GitHub Releases page](https://github.com/bazelbuild/rules_rust/releases). We recommend using the latest release from that page.</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"></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>## </a-p><a-tt>Rules</a-tt></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>- [defs](defs.md): standard rust rules for building and testing libraries and binaries.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>- [rust_doc](rust_doc.md): rules for generating and testing rust documentation.</a-p></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>- [rust_clippy](rust_clippy.md): rules for running [clippy](https://github.com/rust-lang/rust-clippy#readme).</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>- [rust_fmt](rust_fmt.md): rules for running [rustfmt](https://github.com/rust-lang/rustfmt#readme).</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>- [rust_proto](rust_proto.md): rules for generating [protobuf](https://developers.google.com/protocol-buffers) and [gRPC](https://grpc.io) stubs.</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"><a-p>- [rust_bindgen](rust_bindgen.md): rules for generating C++ bindings.</a-p></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>- [rust_wasm_bindgen](rust_wasm_bindgen.md): rules for generating [WebAssembly](https://www.rust-lang.org/what/wasm) bindings.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>- [cargo](cargo.md): Rules dedicated to Cargo compatibility. ie: [`build.rs` scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html).</a-p></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>- [crate_universe](crate_universe.md): Rules for generating Bazel targets for external crate dependencies.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>You can also browse the [full API in one page](flatten.md).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></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>### </a-p><a-tt>Experimental rules</a-tt></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>- [rust_analyzer](rust_analyzer.md): rules for generating `rust-project.json` files for [rust-analyzer](https://rust-analyzer.github.io/)</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"></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-tt>Specifying Rust version</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></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>To build with a particular version of the Rust compiler, pass that version to [`rust_register_toolchains`](flatten.md#rust_register_toolchains):</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>rust_register_toolchains(</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"><a-p>    </a-p><a-v>edition</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;2021&quot;</a-s><a-p>,</a-p></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>    </a-p><a-v>versions</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="L64" href="#L64">64</a><span class="code-text"><a-p>        </a-p><a-s>&quot;1.66.1&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>    ],</a-p></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>)</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>```</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"></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>As well as an exact version, `versions` can accept `nightly/{iso_date}` and `beta/{iso_date}` strings for toolchains from different release channels.</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>rust_register_toolchains(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>    </a-p><a-v>edition</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;2021&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>    </a-p><a-v>versions</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="L75" href="#L75">75</a><span class="code-text"><a-p>        </a-p><a-s>&quot;nightly/2022-12-15&quot;</a-s><a-p>,</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></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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></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>By default, a `stable` and `nightly` toolchain will be registered if no versions are passed to `rust_register_toolchains`. However,</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>if only 1 version is passed and it is from the `nightly` or `beta` release channels (i.e. __not__ `stable`), then a build setting must</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>also be set in the project&#39;s `.bazelrc` file.</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"></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><a-tl>text</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>build --@rules_rust//rust/toolchain/channel=nightly</a-p></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>```</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"></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>Failure to do so will result in rules attempting to match a `stable` toolchain when one was not registered.</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"></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-tt>External Dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></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>[crate_universe](crate_universe.md) is a tool built into `rules_rust` that can be used to fetch dependencies. Additionally, [cargo-raze](https://github.com/google/cargo-raze) is an older third-party which can also fetch dependencies.</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"></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-tt>Supported bazel versions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></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>The oldest version of Bazel the `main` branch is tested against is `5.0.0`. Previous versions may still be functional in certain environments, but this is the minimum version we strive to fully support.</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"></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>We test these rules against the latest rolling releases of Bazel, and aim for compatibility with them, but prioritise stable releases over rolling releases where necessary.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>## </a-p><a-tt>Supported platforms</a-tt></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">We aim to support Linux, macOS, and Windows.</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">Windows support is less complete than the other two platforms, but most things work, and we welcome contributions to help improve its support.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text">Windows support for some features requires `--enable_runfiles` to be passed to Bazel, we recommend putting it in your bazelrc. See [Using Bazel on Windows](https://bazel.build/configure/windows) for more Windows-specific recommendations.</span></span></pre></div></div>
</main>
</body>
</html>
