<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/extensions.md - fork/rules_rust @ cleanup</title>
<meta name="description" content="docs/src/extensions.md in fork/rules_rust at cleanup.">
<meta property="og:title" content="docs/src/extensions.md - fork/rules_rust @ cleanup">
<meta property="og:description" content="docs/src/extensions.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">UebelAndre</span><span class="commit-message" data-commit="2bad96d928961003e3bc8822e9054424a84d2493">Moved rust extension rules into a separate `rules_rust_ext` workspace. (#3007)</span><span class="snapshot-sha sha" data-commit="2bad96d928961003e3bc8822e9054424a84d2493">2bad96d9</span><time datetime="2024-11-26T11:38:21-08:00" title="2024-11-26 11:38:21 -0800">2024-11-26</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">extensions.md</span></nav>
<span class="view-stats"><span>1.6 KiB</span><span>43 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/9cfedf4fa02463748cb593b77e0cca1572d32e3f/docs/src/extensions.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>Extensions</h1>
<p>Bazel rules for interfacing with other rules and integrations with popular 3rd party tools.</p>
<h2>Setup</h2>
<p>The extension rules are released with each release of <code>rules_rust</code> (core) which 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>
<h3>Bzlmod</h3>
<p>Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into.</p>
<p>To use <code>rules_rust</code> extensions in a project using bzlmod, add the following to your <code>MODULE.bazel</code> file:</p>
<pre class="language-python"><a-f>bazel_dep</a-f>(<a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rules_rust_{EXTENSION}&quot;</a-s>, <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;{VERSION}&quot;</a-s>)</pre>
<p>Don't forget to substitute in your desired release's version number and <code>{EXTENSION}</code> with the
name of the desired extension. E.g.:</p>
<pre class="language-python"><a-f>bazel_dep</a-f>(<a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rules_rust_bindgen&quot;</a-s>, <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0.55.0&quot;</a-s>)</pre>
<h3>WORKSPACE</h3>
<p>To use <code>rules_rust</code> extensions in a project using a WORKSPACE file, 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_{EXTENSION}&quot;</a-s>,
    <a-c># See releases page</a-c>
)

<a-c># Refer to the documentation of the desired rules for how to load other necessary dependencies.</a-c></pre>
<p>Don't forget to substitute in your desired release's version number, integrity hash, and <code>{EXTENSION}</code> with the name of the desired extension.</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>Extensions</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">Bazel rules for interfacing with other rules and integrations with popular 3rd party tools.</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"><a-p>##</a-p> <a-tt>Setup</a-tt></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">The extension rules are released with each release of `rules_rust` (core) which can be found on [the GitHub Releases page](https://github.com/bazelbuild/rules_rust/releases). We recommend using the latest release from that page.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>###</a-p> <a-tt>Bzlmod</a-tt></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">Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into.</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">To use `rules_rust` extensions in a project using bzlmod, add the following to your `MODULE.bazel` file:</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>bazel_dep(</a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rules_rust_{EXTENSION}&quot;</a-s><a-p>, </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;{VERSION}&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"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>Don&#39;t forget to substitute in your desired release&#39;s version number and `{EXTENSION}` with the</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"><a-p>name of the desired extension. E.g.:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></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>bazel_dep(</a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rules_rust_bindgen&quot;</a-s><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.55.0&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>```</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"></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-tt>WORKSPACE</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>To use `rules_rust` extensions in a project using a WORKSPACE file, add the following to your `WORKSPACE` file to add the external repositories for the Rust toolchain:</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-tl>python</a-tl></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>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="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># 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="L34" href="#L34">34</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="L35" href="#L35">35</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="L36" href="#L36">36</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_{EXTENSION}&quot;</a-s><a-p>,</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>    </a-p><a-c># See releases page</a-c></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></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># Refer to the documentation of the desired rules for how to load other necessary dependencies.</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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text">Don&#39;t forget to substitute in your desired release&#39;s version number, integrity hash, and `{EXTENSION}` with the name of the desired extension.</span></span></pre></div></div>
</main>
</body>
</html>
