<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/rust_prost.md - fork/rules_rust @ main</title>
<meta name="description" content="docs/src/rust_prost.md in fork/rules_rust at main.">
<meta property="og:title" content="docs/src/rust_prost.md - fork/rules_rust @ main">
<meta property="og:description" content="docs/src/rust_prost.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_prost.md</span></nav>
<span class="view-stats"><span>8.1 KiB</span><span>194 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/3cc3f1058500595c9b74ba2b2a3932e58fc1e4f9/docs/src/rust_prost.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_prost</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/tokio-rs/prost">Prost</a> and <a href="https://github.com/tokio-rs/tonic">Tonic</a></p>
<h2>Rules</h2>
<ul>
<li><a href="#rust_prost_library">rust_prost_library</a></li>
<li><a href="#rust_prost_toolchain">rust_prost_toolchain</a></li>
</ul>
<h2>Setup</h2>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//proto/prost:repositories.bzl&quot;</a-s>, <a-s>&quot;rust_prost_dependencies&quot;</a-s>)

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

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

<a-f>rust_prost_transitive_repositories</a-f>()</pre>
<p>The <code>prost</code> and <code>tonic</code> rules do not specify a default toolchain in order to avoid mismatched
dependency issues. To setup the <code>prost</code> and <code>tonic</code> toolchain, please see the section
<a href="#custom-prost-deps">Customizing <code>prost</code> and <code>tonic</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-prost-deps"&gt;Customizing <code>prost</code> and <code>tonic</code> Dependencies</h4>
<p>These rules depend on the <a href="https://crates.io/crates/prost"><code>prost</code></a> and <a href="https://crates.io/crates/tonic"><code>tonic</code></a> dependencies. To setup the necessary toolchain
for these rules, you must define a toolchain with the <a href="https://crates.io/crates/prost"><code>prost</code></a>, <a href="https://crates.io/crates/prost-types"><code>prost-types</code></a>, <a href="https://crates.io/crates/tonic"><code>tonic</code></a>, <a href="https://crates.io/crates/protoc-gen-prost"><code>protoc-gen-prost</code></a>, and <a href="https://crates.io/crates/protoc-gen-tonic"><code>protoc-gen-tonic</code></a> crates as well as the <a href="https://github.com/protocolbuffers/protobuf"><code>protoc</code></a> binary.</p>
<p>To get access to these crates, you can use the <a href="/fork/rules_rust/ref/main/blob/docs/src/crate_universe.md">crate_universe</a> repository
rules. For example:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;//crate_universe:defs.bzl&quot;</a-s>, <a-s>&quot;crate&quot;</a-s>, <a-s>&quot;crates_repository&quot;</a-s>)

<a-f>crates_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;crates_io&quot;</a-s>,
    <a-v>annotations</a-v> <a-o>=</a-o> {
        <a-s>&quot;protoc-gen-prost&quot;</a-s>: [<a-v>crate</a-v>.<a-pr>annotation</a-pr>(
            <a-v>gen_binaries</a-v> <a-o>=</a-o> [<a-s>&quot;protoc-gen-prost&quot;</a-s>],
            <a-v>patch_args</a-v> <a-o>=</a-o> [
                <a-s>&quot;-p1&quot;</a-s>,
            ],
            <a-v>patches</a-v> <a-o>=</a-o> [
                <a-c># Note: You will need to use this patch until a version greater than `0.2.2` of</a-c>
                <a-c># `protoc-gen-prost` is released.</a-c>
                <a-s>&quot;@rules_rust//proto/prost/private/3rdparty/patches:protoc-gen-prost.patch&quot;</a-s>,
            ],
        )],
        <a-s>&quot;protoc-gen-tonic&quot;</a-s>: [<a-v>crate</a-v>.<a-pr>annotation</a-pr>(
            <a-v>gen_binaries</a-v> <a-o>=</a-o> [<a-s>&quot;protoc-gen-tonic&quot;</a-s>],
        )],
    },
    <a-v>cargo_lockfile</a-v> <a-o>=</a-o> <a-s>&quot;Cargo.Bazel.lock&quot;</a-s>,
    <a-v>mode</a-v> <a-o>=</a-o> <a-s>&quot;remote&quot;</a-s>,
    <a-v>packages</a-v> <a-o>=</a-o> {
        <a-s>&quot;prost&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0&quot;</a-s>,
        ),
        <a-s>&quot;prost-types&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0&quot;</a-s>,
        ),
        <a-s>&quot;protoc-gen-prost&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0&quot;</a-s>,
        ),
        <a-s>&quot;protoc-gen-tonic&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0&quot;</a-s>,
        ),
        <a-s>&quot;tonic&quot;</a-s>: <a-v>crate</a-v>.<a-pr>spec</a-pr>(
            <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;0&quot;</a-s>,
        ),
    },
    <a-v>repository_name</a-v> <a-o>=</a-o> <a-s>&quot;rules_rust_prost&quot;</a-s>,
    <a-v>tags</a-v> <a-o>=</a-o> [<a-s>&quot;manual&quot;</a-s>],
)</pre>
<p>You can then define a toolchain with the <code>rust_prost_toolchain</code> rule which uses the crates
defined above. For example:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//proto/prost:defs.bzl&quot;</a-s>, <a-s>&quot;rust_prost_toolchain&quot;</a-s>)
<a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s>, <a-s>&quot;rust_library_group&quot;</a-s>)

<a-f>rust_library_group</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;prost_runtime&quot;</a-s>,
    <a-v>deps</a-v> <a-o>=</a-o> [
        <a-s>&quot;@crates_io//:prost&quot;</a-s>,
    ],
)

<a-f>rust_library_group</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;tonic_runtime&quot;</a-s>,
    <a-v>deps</a-v> <a-o>=</a-o> [
        <a-s>&quot;:prost_runtime&quot;</a-s>,
        <a-s>&quot;@crates_io//:tonic&quot;</a-s>,
    ],
)

<a-f>rust_prost_toolchain</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;prost_toolchain_impl&quot;</a-s>,
    <a-v>prost_plugin</a-v> <a-o>=</a-o> <a-s>&quot;@crates_io//:protoc-gen-prost__protoc-gen-prost&quot;</a-s>,
    <a-v>prost_runtime</a-v> <a-o>=</a-o> <a-s>&quot;:prost_runtime&quot;</a-s>,
    <a-v>prost_types</a-v> <a-o>=</a-o> <a-s>&quot;@crates_io//:prost-types&quot;</a-s>,
    <a-v>proto_compiler</a-v> <a-o>=</a-o> <a-s>&quot;@com_google_protobuf//:protoc&quot;</a-s>,
    <a-v>tonic_plugin</a-v> <a-o>=</a-o> <a-s>&quot;@crates_io//:protoc-gen-tonic__protoc-gen-tonic&quot;</a-s>,
    <a-v>tonic_runtime</a-v> <a-o>=</a-o> <a-s>&quot;:tonic_runtime&quot;</a-s>,
)

<a-f>toolchain</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;prost_toolchain&quot;</a-s>,
    <a-v>toolchain</a-v> <a-o>=</a-o> <a-s>&quot;prost_toolchain_impl&quot;</a-s>,
    <a-v>toolchain_type</a-v> <a-o>=</a-o> <a-s>&quot;@rules_rust//proto/prost:toolchain_type&quot;</a-s>,
)</pre>
<p>Lastly, you must register the toolchain in your <code>WORKSPACE</code> file. For example:</p>
<pre class="language-python"><a-f>register_toolchains</a-f>(<a-s>&quot;//toolchains:prost_toolchain&quot;</a-s>)</pre>
<hr />
<hr />
<p>&lt;a id="rust_prost_toolchain"&gt;&lt;/a&gt;</p>
<h2>rust_prost_toolchain</h2>
&lt;pre&gt;
rust_prost_toolchain(&lt;a href="#rust_prost_toolchain-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-include_transitive_deps"&gt;include_transitive_deps&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-prost_opts"&gt;prost_opts&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-prost_plugin"&gt;prost_plugin&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-prost_plugin_flag"&gt;prost_plugin_flag&lt;/a&gt;,
                     &lt;a href="#rust_prost_toolchain-prost_runtime"&gt;prost_runtime&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-prost_types"&gt;prost_types&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-proto_compiler"&gt;proto_compiler&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-tonic_opts"&gt;tonic_opts&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-tonic_plugin"&gt;tonic_plugin&lt;/a&gt;,
                     &lt;a href="#rust_prost_toolchain-tonic_plugin_flag"&gt;tonic_plugin_flag&lt;/a&gt;, &lt;a href="#rust_prost_toolchain-tonic_runtime"&gt;tonic_runtime&lt;/a&gt;)
&lt;/pre&gt;
<p>Rust Prost toolchain rule.</p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-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_prost_toolchain-include_transitive_deps"&gt;&lt;/a&gt;include_transitive_deps</td><td style="text-align: left">Whether to include transitive dependencies. If set to True, all transitive dependencies will directly accessible by the dependent crate.</td><td style="text-align: left">Boolean</td><td style="text-align: left">optional</td><td style="text-align: left"><code>False</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-prost_opts"&gt;&lt;/a&gt;prost_opts</td><td style="text-align: left">Additional options to add to Prost.</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>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-prost_plugin"&gt;&lt;/a&gt;prost_plugin</td><td style="text-align: left">Additional plugins to add to Prost.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-prost_plugin_flag"&gt;&lt;/a&gt;prost_plugin_flag</td><td style="text-align: left">Prost plugin flag format. (e.g. <code>--plugin=protoc-gen-prost=%s</code>)</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"--plugin=protoc-gen-prost=%s"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-prost_runtime"&gt;&lt;/a&gt;prost_runtime</td><td style="text-align: left">The Prost runtime crates to use.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-prost_types"&gt;&lt;/a&gt;prost_types</td><td style="text-align: left">The Prost types crates to use.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-proto_compiler"&gt;&lt;/a&gt;proto_compiler</td><td style="text-align: left">The protoc compiler to use. Note that this attribute is deprecated - prefer to use --incompatible_enable_proto_toolchain_resolution.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-tonic_opts"&gt;&lt;/a&gt;tonic_opts</td><td style="text-align: left">Additional options to add to Tonic.</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>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-tonic_plugin"&gt;&lt;/a&gt;tonic_plugin</td><td style="text-align: left">Additional plugins to add to Tonic.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-tonic_plugin_flag"&gt;&lt;/a&gt;tonic_plugin_flag</td><td style="text-align: left">Tonic plugin flag format. (e.g. <code>--plugin=protoc-gen-tonic=%s</code>))</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"--plugin=protoc-gen-tonic=%s"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_toolchain-tonic_runtime"&gt;&lt;/a&gt;tonic_runtime</td><td style="text-align: left">The Tonic runtime crates to use.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
</tbody></table>
<p>&lt;a id="rust_prost_library"&gt;&lt;/a&gt;</p>
<h2>rust_prost_library</h2>
&lt;pre&gt;
rust_prost_library(&lt;a href="#rust_prost_library-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_prost_library-kwargs"&gt;kwargs&lt;/a&gt;)
&lt;/pre&gt;
<p>A rule for generating a Rust library using Prost.</p>
<p><strong>PARAMETERS</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Default Value</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_prost_library-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">The name of the target.</td><td style="text-align: left">none</td></tr>
<tr><td style="text-align: left">&lt;a id="rust_prost_library-kwargs"&gt;&lt;/a&gt;kwargs</td><td style="text-align: left">Additional keyword arguments for the underlying <code>rust_prost_library</code> rule.</td><td style="text-align: left">none</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_prost</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 [Prost][prost] and [Tonic][tonic]</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>[prost]</a-tu>: <a-tu>https://github.com/tokio-rs/prost</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"><a-tu>[tonic]</a-tu>: <a-tu>https://github.com/tokio-rs/tonic</a-tu></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>Rules</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"><a-p>- </a-p>[rust_prost_library](#rust_prost_library)</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>[rust_prost_toolchain](#rust_prost_toolchain)</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>## </a-p><a-tt>Setup</a-tt></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>```</a-p><a-tl>python</a-tl></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>load(</a-p><a-s>&quot;@rules_rust//proto/prost:repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_prost_dependencies&quot;</a-s><a-p>)</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"></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>rust_prost_dependencies()</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>load(</a-p><a-s>&quot;@rules_rust//proto/prost:transitive_repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_prost_transitive_repositories&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"></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>rust_prost_transitive_repositories()</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"><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>The `prost` and `tonic` rules do not specify a default toolchain in order to avoid mismatched</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"><a-p>dependency issues. To setup the `prost` and `tonic` toolchain, please see the section</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>[Customizing `prost` and `tonic` Dependencies](#custom-prost-deps).</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"></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>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="L36" href="#L36">36</a><span class="code-text"></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-tt>&lt;a name=&quot;custom-prost-deps&quot;&gt;Customizing `prost` and `tonic` Dependencies</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>These rules depend on the [`prost`] and [`tonic`] dependencies. To setup the necessary toolchain</a-p></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>for these rules, you must define a toolchain with the [`prost`], [`prost-types`], [`tonic`], [`protoc-gen-prost`], and [`protoc-gen-tonic`] crates as well as the [`protoc`] binary.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-tu>[`prost`]</a-tu><a-p>: </a-p><a-tu>https://crates.io/crates/prost</a-tu></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-tu>[`prost-types`]</a-tu><a-p>: </a-p><a-tu>https://crates.io/crates/prost-types</a-tu></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-tu>[`protoc-gen-prost`]</a-tu><a-p>: </a-p><a-tu>https://crates.io/crates/protoc-gen-prost</a-tu></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-tu>[`protoc-gen-tonic`]</a-tu><a-p>: </a-p><a-tu>https://crates.io/crates/protoc-gen-tonic</a-tu></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-tu>[`tonic`]</a-tu><a-p>: </a-p><a-tu>https://crates.io/crates/tonic</a-tu></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-tu>[`protoc`]</a-tu><a-p>: </a-p><a-tu>https://github.com/protocolbuffers/protobuf</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></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>To get access to these crates, you can use the [crate_universe](./crate_universe.md) repository</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>rules. For example:</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-tl>python</a-tl></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>load(</a-p><a-s>&quot;//crate_universe:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;crate&quot;</a-s><a-p>, </a-p><a-s>&quot;crates_repository&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>crates_repository(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;crates_io&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>    </a-p><a-v>annotations</a-v><a-p> </a-p><a-o>=</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>        </a-p><a-s>&quot;protoc-gen-prost&quot;</a-s><a-p>: [</a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>annotation</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>            </a-p><a-v>gen_binaries</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;protoc-gen-prost&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>            </a-p><a-v>patch_args</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="L61" href="#L61">61</a><span class="code-text"><a-p>                </a-p><a-s>&quot;-p1&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><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>patches</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-c># Note: You will need to use this patch until a version greater than `0.2.2` of</a-c></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># `protoc-gen-prost` is released.</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-s>&quot;@rules_rust//proto/prost/private/3rdparty/patches:protoc-gen-prost.patch&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"><a-p>        )],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>        </a-p><a-s>&quot;protoc-gen-tonic&quot;</a-s><a-p>: [</a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>annotation</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>            </a-p><a-v>gen_binaries</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;protoc-gen-tonic&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></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></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>cargo_lockfile</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;Cargo.Bazel.lock&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>    </a-p><a-v>mode</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;remote&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>    </a-p><a-v>packages</a-v><a-p> </a-p><a-o>=</a-o><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>        </a-p><a-s>&quot;prost&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0&quot;</a-s><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"><a-p>        </a-p><a-s>&quot;prost-types&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0&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"><a-p>        </a-p><a-s>&quot;protoc-gen-prost&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>        ),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>        </a-p><a-s>&quot;protoc-gen-tonic&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0&quot;</a-s><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"><a-p>        ),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>        </a-p><a-s>&quot;tonic&quot;</a-s><a-p>: </a-p><a-v>crate</a-v><a-p>.</a-p><a-pr>spec</a-pr><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>            </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;0&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>        ),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>    },</a-p></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><a-v>repository_name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rules_rust_prost&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>    </a-p><a-v>tags</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;manual&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></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>You can then define a toolchain with the `rust_prost_toolchain` rule which uses the crates</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>defined above. For example:</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-tl>python</a-tl></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>load(</a-p><a-s>&quot;@rules_rust//proto/prost:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_prost_toolchain&quot;</a-s><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>load(</a-p><a-s>&quot;@rules_rust//rust:defs.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_library_group&quot;</a-s><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"></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>rust_library_group(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;prost_runtime&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>    </a-p><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@crates_io//:prost&quot;</a-s><a-p>,</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>    ],</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>)</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>rust_library_group(</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><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;tonic_runtime&quot;</a-s><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"><a-p>    </a-p><a-v>deps</a-v><a-p> </a-p><a-o>=</a-o><a-p> [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>        </a-p><a-s>&quot;:prost_runtime&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>        </a-p><a-s>&quot;@crates_io//:tonic&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>    ],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"></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_prost_toolchain(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;prost_toolchain_impl&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>    </a-p><a-v>prost_plugin</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@crates_io//:protoc-gen-prost__protoc-gen-prost&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>    </a-p><a-v>prost_runtime</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:prost_runtime&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>    </a-p><a-v>prost_types</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@crates_io//:prost-types&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>    </a-p><a-v>proto_compiler</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="L125" href="#L125">125</a><span class="code-text"><a-p>    </a-p><a-v>tonic_plugin</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@crates_io//:protoc-gen-tonic__protoc-gen-tonic&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>    </a-p><a-v>tonic_runtime</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:tonic_runtime&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>)</a-p></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>toolchain(</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;prost_toolchain&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>toolchain</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;prost_toolchain_impl&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><a-v>toolchain_type</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@rules_rust//proto/prost:toolchain_type&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>```</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"></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>Lastly, you must register the toolchain in your `WORKSPACE` file. For example:</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></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>register_toolchains(</a-p><a-s>&quot;//toolchains:prost_toolchain&quot;</a-s><a-p>)</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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"><a-p>---</a-p></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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p>&lt;a id=&quot;rust_prost_toolchain&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>## </a-p><a-tt>rust_prost_toolchain</a-tt></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>&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="L150" href="#L150">150</a><span class="code-text"><a-p>rust_prost_toolchain(&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_prost_toolchain-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_prost_toolchain-include_transitive_deps</a-s><a-p>&quot;&gt;include_transitive_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_prost_toolchain-prost_opts</a-s><a-p>&quot;&gt;prost_opts&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_prost_toolchain-prost_plugin</a-s><a-p>&quot;&gt;prost_plugin&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_prost_toolchain-prost_plugin_flag</a-s><a-p>&quot;&gt;prost_plugin_flag&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="L151" href="#L151">151</a><span class="code-text"><a-p>                     &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_prost_toolchain-prost_runtime</a-s><a-p>&quot;&gt;prost_runtime&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_prost_toolchain-prost_types</a-s><a-p>&quot;&gt;prost_types&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_prost_toolchain-proto_compiler</a-s><a-p>&quot;&gt;proto_compiler&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_prost_toolchain-tonic_opts</a-s><a-p>&quot;&gt;tonic_opts&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_prost_toolchain-tonic_plugin</a-s><a-p>&quot;&gt;tonic_plugin&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="L152" href="#L152">152</a><span class="code-text"><a-p>                     &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_prost_toolchain-tonic_plugin_flag</a-s><a-p>&quot;&gt;tonic_plugin_flag&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_prost_toolchain-tonic_runtime</a-s><a-p>&quot;&gt;tonic_runtime&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="L153" href="#L153">153</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="L154" href="#L154">154</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"><a-p>Rust Prost toolchain rule.</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"><a-p>**ATTRIBUTES**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"></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>| Name  | Description | Type | Mandatory | Default |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-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="L163" href="#L163">163</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-include_transitive_deps&quot;&gt;&lt;/a&gt;include_transitive_deps |  Whether to include transitive dependencies. If set to True, all transitive dependencies will directly accessible by the dependent crate.   | Boolean | optional |  `False`  |</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 id=&quot;rust_prost_toolchain-prost_opts&quot;&gt;&lt;/a&gt;prost_opts |  Additional options to add to Prost.   | List of strings | optional |  `[]`  |</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"><a-p>| &lt;a id=&quot;rust_prost_toolchain-prost_plugin&quot;&gt;&lt;/a&gt;prost_plugin |  Additional plugins to add to Prost.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-prost_plugin_flag&quot;&gt;&lt;/a&gt;prost_plugin_flag |  Prost plugin flag format. (e.g. `--plugin=protoc-gen-prost=%s`)   | String | optional |  `&quot;--plugin=protoc-gen-prost=%s&quot;`  |</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"><a-p>| &lt;a id=&quot;rust_prost_toolchain-prost_runtime&quot;&gt;&lt;/a&gt;prost_runtime |  The Prost runtime crates to use.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-prost_types&quot;&gt;&lt;/a&gt;prost_types |  The Prost types crates to use.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-proto_compiler&quot;&gt;&lt;/a&gt;proto_compiler |  The protoc compiler to use. Note that this attribute is deprecated - prefer to use --incompatible_enable_proto_toolchain_resolution.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-tonic_opts&quot;&gt;&lt;/a&gt;tonic_opts |  Additional options to add to Tonic.   | List of strings | optional |  `[]`  |</a-p></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>| &lt;a id=&quot;rust_prost_toolchain-tonic_plugin&quot;&gt;&lt;/a&gt;tonic_plugin |  Additional plugins to add to Tonic.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-tonic_plugin_flag&quot;&gt;&lt;/a&gt;tonic_plugin_flag |  Tonic plugin flag format. (e.g. `--plugin=protoc-gen-tonic=%s`))   | String | optional |  `&quot;--plugin=protoc-gen-tonic=%s&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_prost_toolchain-tonic_runtime&quot;&gt;&lt;/a&gt;tonic_runtime |  The Tonic runtime crates to use.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional |  `None`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>&lt;a id=&quot;rust_prost_library&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p>## </a-p><a-tt>rust_prost_library</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>rust_prost_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_prost_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_prost_library-kwargs</a-s><a-p>&quot;&gt;kwargs&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</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="L183" href="#L183">183</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text">A rule for generating a Rust library using Prost.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text">**PARAMETERS**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text">| Name  | Description | Default Value |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text">| :------------- | :------------- | :------------- |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text">| &lt;a id=&quot;rust_prost_library-name&quot;&gt;&lt;/a&gt;name |  The name of the target.   |  none |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text">| &lt;a id=&quot;rust_prost_library-kwargs&quot;&gt;&lt;/a&gt;kwargs |  Additional keyword arguments for the underlying `rust_prost_library` rule.   |  none |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
