<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/rust_protobuf.md - fork/rules_rust @ main</title>
<meta name="description" content="docs/src/rust_protobuf.md in fork/rules_rust at main.">
<meta property="og:title" content="docs/src/rust_protobuf.md - fork/rules_rust @ main">
<meta property="og:description" content="docs/src/rust_protobuf.md in fork/rules_rust at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="c07cb1b5e1bec3184239c28bdddd6c5a0a97d634">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">UebelAndre</span><span class="commit-message" data-commit="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>main</summary><div class="menu"><strong>branches</strong><a href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a class="current" href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/main/tree/docs/">docs</a> / <a href="/fork/rules_rust/ref/main/tree/docs/src/">src</a> / <span class="cur">rust_protobuf.md</span></nav>
<span class="view-stats"><span>8.3 KiB</span><span>201 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/035d5c85344b62c3410c7c4f78555c5740582501/docs/src/rust_protobuf.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>rules_rust_protobuf</h1>
<p>These build rules are used for building <a href="https://developers.google.com/protocol-buffers/">protobufs</a>/<a href="https://grpc.io">gRPC</a> in <a href="http://www.rust-lang.org/">Rust</a> with Bazel
using <a href="https://github.com/stepancheg/rust-protobuf/"><code>rust-protobuf</code></a>.</p>
<h2>Setup</h2>
<p>To use the Rust proto rules, add the following to your <code>WORKSPACE</code> file to add the
external repositories for the Rust proto toolchain (in addition to the <a href="/fork/rules_rust/ref/main/tree/docs/">rust rules setup</a>):</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//proto/protobuf:repositories.bzl&quot;</a-s>, <a-s>&quot;rust_proto_protobuf_dependencies&quot;</a-s>, <a-s>&quot;rust_proto_protobuf_register_toolchains&quot;</a-s>)

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

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

<a-f>load</a-f>(<a-s>&quot;@rules_rust//proto/protobuf:transitive_repositories.bzl&quot;</a-s>, <a-s>&quot;rust_proto_protobuf_transitive_repositories&quot;</a-s>)

<a-f>rust_proto_protobuf_transitive_repositories</a-f>()</pre>
<p>This will load the required dependencies for the <a href="https://github.com/stepancheg/rust-protobuf/"><code>rust-protobuf</code></a> rules. It will also
register a default toolchain for the <code>rust_proto_library</code> and <code>rust_grpc_library</code> rules.</p>
<p>To customize the <code>rust_proto_library</code> and <code>rust_grpc_library</code> toolchain, please see the section
<a href="#custom-proto-deps">Customizing <code>rust-protobuf</code> Dependencies</a>.</p>
<p>For additional information about Bazel toolchains, see <a href="https://docs.bazel.build/versions/master/toolchains.html">here</a>.</p>
<h4>&lt;a name="custom-proto-deps"&gt;Customizing <code>rust-protobuf</code> Dependencies</h4>
<p>These rules depend on the <a href="https://crates.io/crates/protobuf"><code>protobuf</code></a> and
the <a href="https://crates.io/crates/grpc"><code>grpc</code></a> crates in addition to the <a href="https://github.com/google/protobuf">protobuf
compiler</a>. To obtain these crates,
<code>rust_proto_repositories</code> imports the given crates using BUILD files generated with
<a href="/fork/rules_rust/ref/main/blob/docs/src/crate_universe.md">crate_universe</a>.</p>
<p>If you want to either change the protobuf and gRPC rust compilers, or to
simply use <a href="/fork/rules_rust/ref/main/blob/docs/src/crate_universe.md">crate_universe</a> in a more
complex scenario (with more dependencies), you must redefine those
dependencies.</p>
<p>To do this, once you've imported the needed dependencies (see our
<a href="https://github.com/bazelbuild/rules_rust/blob/main/proto/protobuf/3rdparty/BUILD.bazel">@rules_rust//proto/protobuf/3rdparty/BUILD.bazel</a>
file to see the default dependencies), you need to create your own toolchain.
To do so you can create a BUILD file with your toolchain definition, for example:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//proto:toolchain.bzl&quot;</a-s>, <a-s>&quot;rust_proto_toolchain&quot;</a-s>)

<a-f>rust_proto_toolchain</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;proto-toolchain-impl&quot;</a-s>,
    <a-c># Path to the protobuf compiler.</a-c>
    <a-v>protoc</a-v> <a-o>=</a-o> <a-s>&quot;@com_google_protobuf//:protoc&quot;</a-s>,
    <a-c># Protobuf compiler plugin to generate rust gRPC stubs.</a-c>
    <a-v>grpc_plugin</a-v> <a-o>=</a-o> <a-s>&quot;//3rdparty/crates:cargo_bin_protoc_gen_rust_grpc&quot;</a-s>,
    <a-c># Protobuf compiler plugin to generate rust protobuf stubs.</a-c>
    <a-v>proto_plugin</a-v> <a-o>=</a-o> <a-s>&quot;//3rdparty/crates:cargo_bin_protoc_gen_rust&quot;</a-s>,
)

<a-f>toolchain</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;proto-toolchain&quot;</a-s>,
    <a-v>toolchain</a-v> <a-o>=</a-o> <a-s>&quot;:proto-toolchain-impl&quot;</a-s>,
    <a-v>toolchain_type</a-v> <a-o>=</a-o> <a-s>&quot;@rules_rust//proto/protobuf:toolchain_type&quot;</a-s>,
)</pre>
<p>Now that you have your own toolchain, you need to register it by
inserting the following statement in your <code>WORKSPACE</code> file:</p>
<pre class="language-python"><a-f>register_toolchains</a-f>(<a-s>&quot;//my/toolchains:proto-toolchain&quot;</a-s>)</pre>
<p>Finally, you might want to set the <code>rust_deps</code> attribute in
<code>rust_proto_library</code> and <code>rust_grpc_library</code> to change the compile-time
dependencies:</p>
<pre class="language-python"><a-f>rust_proto_library</a-f>(
    ...
    <a-v>rust_deps</a-v> <a-o>=</a-o> [<a-s>&quot;//3rdparty/crates:protobuf&quot;</a-s>],
    ...
)

<a-f>rust_grpc_library</a-f>(
    ...
    <a-v>rust_deps</a-v> <a-o>=</a-o> [
        <a-s>&quot;//3rdparty/crates:protobuf&quot;</a-s>,
        <a-s>&quot;//3rdparty/crates:grpc&quot;</a-s>,
        <a-s>&quot;//3rdparty/crates:tls_api&quot;</a-s>,
        <a-s>&quot;//3rdparty/crates:tls_api_stub&quot;</a-s>,
    ],
    ...
)</pre>
<p><strong>Note</strong>: Ideally, we would inject those dependencies from the toolchain,
but due to <a href="https://github.com/bazelbuild/bazel/issues/6889">bazelbuild/bazel#6889</a>
all dependencies added via the toolchain ends-up being in the wrong
configuration.</p>
<hr />
<hr />
<p>&lt;a id="rust_grpc_library"&gt;&lt;/a&gt;</p>
<h2>rust_grpc_library</h2>
&lt;pre&gt;
rust_grpc_library(&lt;a href="#rust_grpc_library-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_grpc_library-deps"&gt;deps&lt;/a&gt;, &lt;a href="#rust_grpc_library-crate_name"&gt;crate_name&lt;/a&gt;, &lt;a href="#rust_grpc_library-rust_deps"&gt;rust_deps&lt;/a&gt;, &lt;a href="#rust_grpc_library-rustc_flags"&gt;rustc_flags&lt;/a&gt;)
&lt;/pre&gt;
<p>Builds a Rust library crate from a set of <code>proto_library</code>s suitable for gRPC.</p>
<p>Example:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust_protobuf//:defs.bzl&quot;</a-s>, <a-s>&quot;rust_grpc_library&quot;</a-s>)

<a-f>proto_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;my_proto&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;my.proto&quot;</a-s>]
)

<a-f>rust_grpc_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rust&quot;</a-s>,
    <a-v>deps</a-v> <a-o>=</a-o> [<a-s>&quot;:my_proto&quot;</a-s>],
)

<a-f>rust_binary</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;my_service&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;my_service.rs&quot;</a-s>],
    <a-v>deps</a-v> <a-o>=</a-o> [<a-s>&quot;:rust&quot;</a-s>],
)</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="rust_grpc_library-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="rust_grpc_library-deps"&gt;&lt;/a&gt;deps</td><td style="text-align: left">List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding gRPC stubs.</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">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_grpc_library-crate_name"&gt;&lt;/a&gt;crate_name</td><td style="text-align: left">Crate name to use for this target.&lt;br&gt;&lt;br&gt;This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores.</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="rust_grpc_library-rust_deps"&gt;&lt;/a&gt;rust_deps</td><td style="text-align: left">The crates the generated library depends on.</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="rust_grpc_library-rustc_flags"&gt;&lt;/a&gt;rustc_flags</td><td style="text-align: left">List of compiler flags passed to <code>rustc</code>.&lt;br&gt;&lt;br&gt;These strings are subject to Make variable expansion for predefined source/output path variables like <code>$location</code>, <code>$execpath</code>, and <code>$rootpath</code>. This expansion is useful if you wish to pass a generated file of arguments to rustc: <code>@$(location //package:target)</code>.</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
</tbody></table>
<p>&lt;a id="rust_proto_library"&gt;&lt;/a&gt;</p>
<h2>rust_proto_library</h2>
&lt;pre&gt;
rust_proto_library(&lt;a href="#rust_proto_library-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_proto_library-deps"&gt;deps&lt;/a&gt;, &lt;a href="#rust_proto_library-crate_name"&gt;crate_name&lt;/a&gt;, &lt;a href="#rust_proto_library-rust_deps"&gt;rust_deps&lt;/a&gt;, &lt;a href="#rust_proto_library-rustc_flags"&gt;rustc_flags&lt;/a&gt;)
&lt;/pre&gt;
<p>Builds a Rust library crate from a set of <code>proto_library</code>s.</p>
<p>Example:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust_protobuf//:defs.bzl&quot;</a-s>, <a-s>&quot;rust_proto_library&quot;</a-s>)

<a-f>proto_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;my_proto&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;my.proto&quot;</a-s>]
)

<a-f>rust_proto_library</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rust&quot;</a-s>,
    <a-v>deps</a-v> <a-o>=</a-o> [<a-s>&quot;:my_proto&quot;</a-s>],
)

<a-f>rust_binary</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;my_proto_binary&quot;</a-s>,
    <a-v>srcs</a-v> <a-o>=</a-o> [<a-s>&quot;my_proto_binary.rs&quot;</a-s>],
    <a-v>deps</a-v> <a-o>=</a-o> [<a-s>&quot;:rust&quot;</a-s>],
)</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="rust_proto_library-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="rust_proto_library-deps"&gt;&lt;/a&gt;deps</td><td style="text-align: left">List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding stubs.</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">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_proto_library-crate_name"&gt;&lt;/a&gt;crate_name</td><td style="text-align: left">Crate name to use for this target.&lt;br&gt;&lt;br&gt;This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores.</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="rust_proto_library-rust_deps"&gt;&lt;/a&gt;rust_deps</td><td style="text-align: left">The crates the generated library depends on.</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="rust_proto_library-rustc_flags"&gt;&lt;/a&gt;rustc_flags</td><td style="text-align: left">List of compiler flags passed to <code>rustc</code>.&lt;br&gt;&lt;br&gt;These strings are subject to Make variable expansion for predefined source/output path variables like <code>$location</code>, <code>$execpath</code>, and <code>$rootpath</code>. This expansion is useful if you wish to pass a generated file of arguments to rustc: <code>@$(location //package:target)</code>.</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
</tbody></table>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></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>rules_rust_protobuf</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">These build rules are used for building [protobufs][protobuf]/[gRPC][grpc] in [Rust][rust] with 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">using [`rust-protobuf`].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></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"><a-tu>[protobuf]</a-tu>: <a-tu>https://developers.google.com/protocol-buffers/</a-tu></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-tu>[grpc]</a-tu>: <a-tu>https://grpc.io</a-tu></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-tu>[`rust-protobuf`]</a-tu>: <a-tu>https://github.com/stepancheg/rust-protobuf/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>##</a-p> <a-tt>Setup</a-tt></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">To use the Rust proto rules, add the following to your `WORKSPACE` file to add the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">external repositories for the Rust proto toolchain (in addition to the [rust rules setup](..)):</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;@rules_rust//proto/protobuf:repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_proto_protobuf_dependencies&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_proto_protobuf_register_toolchains&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>rust_proto_protobuf_dependencies()</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"></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>rust_proto_protobuf_register_toolchains()</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>load(</a-p><a-s>&quot;@rules_rust//proto/protobuf:transitive_repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_proto_protobuf_transitive_repositories&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"></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>rust_proto_protobuf_transitive_repositories()</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>```</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>This will load the required dependencies for the [`rust-protobuf`] rules. It will also</a-p></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>register a default toolchain for the `rust_proto_library` and `rust_grpc_library` rules.</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 customize the `rust_proto_library` and `rust_grpc_library` toolchain, please see the section</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>[Customizing `rust-protobuf` Dependencies](#custom-proto-deps).</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>For additional information about Bazel toolchains, see [here](https://docs.bazel.build/versions/master/toolchains.html).</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>&lt;a name=&quot;custom-proto-deps&quot;&gt;Customizing `rust-protobuf` Dependencies</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>These rules depend on the [`protobuf`](https://crates.io/crates/protobuf) and</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>the [`grpc`](https://crates.io/crates/grpc) crates in addition to the [protobuf</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>compiler](https://github.com/google/protobuf). To obtain these crates,</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_proto_repositories` imports the given crates using BUILD files generated with</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>[crate_universe](./crate_universe.md).</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>If you want to either change the protobuf and gRPC rust compilers, or to</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>simply use [crate_universe](./crate_universe.md) in a more</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>complex scenario (with more dependencies), you must redefine those</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>dependencies.</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>To do this, once you&#39;ve imported the needed dependencies (see our</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>[@rules_rust//proto/protobuf/3rdparty/BUILD.bazel](https://github.com/bazelbuild/rules_rust/blob/main/proto/protobuf/3rdparty/BUILD.bazel)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>file to see the default dependencies), you need to create your own toolchain.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>To do so you can create a BUILD file with your toolchain definition, for example:</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-tl>python</a-tl></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>load(</a-p><a-s>&quot;@rules_rust//proto:toolchain.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_proto_toolchain&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"></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>rust_proto_toolchain(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;proto-toolchain-impl&quot;</a-s><a-p>,</a-p></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>    </a-p><a-c># Path to the protobuf compiler.</a-c></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>protoc</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@com_google_protobuf//:protoc&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-c># Protobuf compiler plugin to generate rust gRPC stubs.</a-c></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-v>grpc_plugin</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//3rdparty/crates:cargo_bin_protoc_gen_rust_grpc&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>    </a-p><a-c># Protobuf compiler plugin to generate rust protobuf stubs.</a-c></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><a-v>proto_plugin</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;//3rdparty/crates:cargo_bin_protoc_gen_rust&quot;</a-s><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>toolchain(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;proto-toolchain&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>    </a-p><a-v>toolchain</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:proto-toolchain-impl&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>    </a-p><a-v>toolchain_type</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@rules_rust//proto/protobuf:toolchain_type&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>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></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>Now that you have your own toolchain, you need to register it by</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>inserting the following statement in your `WORKSPACE` file:</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"></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-tl>python</a-tl></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>register_toolchains(</a-p><a-s>&quot;//my/toolchains:proto-toolchain&quot;</a-s><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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></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>Finally, you might want to set the `rust_deps` attribute in</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>`rust_proto_library` and `rust_grpc_library` to change the compile-time</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"><a-p>dependencies:</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"></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-tl>python</a-tl></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>rust_proto_library(</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></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>rust_deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;//3rdparty/crates:protobuf&quot;</a-s><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></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"></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>rust_grpc_library(</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>rust_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="L97" href="#L97">97</a><span class="code-text"><a-p>        </a-p><a-s>&quot;//3rdparty/crates:protobuf&quot;</a-s><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><a-s>&quot;//3rdparty/crates:grpc&quot;</a-s><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><a-s>&quot;//3rdparty/crates:tls_api&quot;</a-s><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><a-s>&quot;//3rdparty/crates:tls_api_stub&quot;</a-s><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"><a-p>    ],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>    ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>```</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"></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>__Note__: Ideally, we would inject those dependencies from the toolchain,</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>but due to [bazelbuild/bazel#6889](https://github.com/bazelbuild/bazel/issues/6889)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>all dependencies added via the toolchain ends-up being in the wrong</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>configuration.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>---</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>&lt;a id=&quot;rust_grpc_library&quot;&gt;&lt;/a&gt;</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"></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-tt>rust_grpc_library</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>&lt;</a-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="L119" href="#L119">119</a><span class="code-text"><a-p>rust_grpc_library(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_grpc_library-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>#rust_grpc_library-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>#rust_grpc_library-crate_name</a-s><a-p>&quot;&gt;crate_name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_grpc_library-rust_deps</a-s><a-p>&quot;&gt;rust_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>#rust_grpc_library-rustc_flags</a-s><a-p>&quot;&gt;rustc_flags&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="L120" href="#L120">120</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="L121" href="#L121">121</a><span class="code-text"></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>Builds a Rust library crate from a set of `proto_library`s suitable for gRPC.</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"></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>Example:</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"></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><a-tl>python</a-tl></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>load(</a-p><a-s>&quot;@rules_rust_protobuf//:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_grpc_library&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>proto_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;my_proto&quot;</a-s><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>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;my.proto&quot;</a-s><a-p>]</a-p></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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>rust_grpc_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rust&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"><a-p>    </a-p><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;:my_proto&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>rust_binary(</a-p></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>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;my_service&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;my_service.rs&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>    </a-p><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;:rust&quot;</a-s><a-p>],</a-p></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>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"></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>**ATTRIBUTES**</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></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>| Name  | Description | Type | Mandatory | Default |</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></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>| &lt;a id=&quot;rust_grpc_library-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="L152" href="#L152">152</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_grpc_library-deps&quot;&gt;&lt;/a&gt;deps |  List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding gRPC stubs.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | required |  |</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>| &lt;a id=&quot;rust_grpc_library-crate_name&quot;&gt;&lt;/a&gt;crate_name |  Crate name to use for this target.&lt;br&gt;&lt;br&gt;This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores.   | String | optional |  `&quot;&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_grpc_library-rust_deps&quot;&gt;&lt;/a&gt;rust_deps |  The crates the generated library depends on.   | &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="L155" href="#L155">155</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_grpc_library-rustc_flags&quot;&gt;&lt;/a&gt;rustc_flags |  List of compiler flags passed to `rustc`.&lt;br&gt;&lt;br&gt;These strings are subject to Make variable expansion for predefined source/output path variables like `$location`, `$execpath`, and `$rootpath`. This expansion is useful if you wish to pass a generated file of arguments to rustc: `@$(location //package:target)`.   | List of strings | optional |  `[]`  |</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></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>&lt;a id=&quot;rust_proto_library&quot;&gt;&lt;/a&gt;</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"></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><a-tt>rust_proto_library</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></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>&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="L163" href="#L163">163</a><span class="code-text"><a-p>rust_proto_library(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_proto_library-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>#rust_proto_library-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>#rust_proto_library-crate_name</a-s><a-p>&quot;&gt;crate_name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_proto_library-rust_deps</a-s><a-p>&quot;&gt;rust_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>#rust_proto_library-rustc_flags</a-s><a-p>&quot;&gt;rustc_flags&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="L164" href="#L164">164</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="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>Builds a Rust library crate from a set of `proto_library`s.</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>Example:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</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="L171" href="#L171">171</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust_protobuf//:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_proto_library&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>proto_library(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;my_proto&quot;</a-s><a-p>,</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>    </a-p><a-v>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;my.proto&quot;</a-s><a-p>]</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>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p>rust_proto_library(</a-p></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-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rust&quot;</a-s><a-p>,</a-p></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>    </a-p><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;:my_proto&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>rust_binary(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;my_proto_binary&quot;</a-s><a-p>,</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>srcs</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;my_proto_binary.rs&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>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;:rust&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></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text">**ATTRIBUTES**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text">| Name  | Description | Type | Mandatory | Default |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="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">| &lt;a id=&quot;rust_proto_library-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 |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text">| &lt;a id=&quot;rust_proto_library-deps&quot;&gt;&lt;/a&gt;deps |  List of proto_library dependencies that will be built. One crate for each proto_library will be created with the corresponding stubs.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text">| &lt;a id=&quot;rust_proto_library-crate_name&quot;&gt;&lt;/a&gt;crate_name |  Crate name to use for this target.&lt;br&gt;&lt;br&gt;This must be a valid Rust identifier, i.e. it may contain only alphanumeric characters and underscores. Defaults to the target name, with any hyphens replaced by underscores.   | String | optional |  `&quot;&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text">| &lt;a id=&quot;rust_proto_library-rust_deps&quot;&gt;&lt;/a&gt;rust_deps |  The crates the generated library depends on.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;List of labels&lt;/a&gt; | optional |  `[]`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text">| &lt;a id=&quot;rust_proto_library-rustc_flags&quot;&gt;&lt;/a&gt;rustc_flags |  List of compiler flags passed to `rustc`.&lt;br&gt;&lt;br&gt;These strings are subject to Make variable expansion for predefined source/output path variables like `$location`, `$execpath`, and `$rootpath`. This expansion is useful if you wish to pass a generated file of arguments to rustc: `@$(location //package:target)`.   | List of strings | optional |  `[]`  |</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"></span></span></pre></div></div>
</main>
</body>
</html>
