| <!DOCTYPE HTML> |
| <html lang="en" class="light sidebar-visible" dir="ltr"> |
| <head> |
| <!-- Book generated using mdBook --> |
| <meta charset="UTF-8"> |
| <title>proto - rules_rust</title> |
| |
| |
| <!-- Custom HTML head --> |
| |
| <meta name="description" content=""> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="theme-color" content="#ffffff"> |
| |
| <link rel="icon" href="favicon.svg"> |
| <link rel="shortcut icon" href="favicon.png"> |
| <link rel="stylesheet" href="css/variables.css"> |
| <link rel="stylesheet" href="css/general.css"> |
| <link rel="stylesheet" href="css/chrome.css"> |
| <link rel="stylesheet" href="css/print.css" media="print"> |
| |
| <!-- Fonts --> |
| <link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> |
| <link rel="stylesheet" href="fonts/fonts.css"> |
| |
| <!-- Highlight.js Stylesheets --> |
| <link rel="stylesheet" href="highlight.css"> |
| <link rel="stylesheet" href="tomorrow-night.css"> |
| <link rel="stylesheet" href="ayu-highlight.css"> |
| |
| <!-- Custom theme stylesheets --> |
| |
| |
| <!-- Provide site root to javascript --> |
| <script> |
| var path_to_root = ""; |
| var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; |
| </script> |
| <!-- Start loading toc.js asap --> |
| <script src="toc.js"></script> |
| </head> |
| <body> |
| <div id="body-container"> |
| <!-- Work around some values being stored in localStorage wrapped in quotes --> |
| <script> |
| try { |
| var theme = localStorage.getItem('mdbook-theme'); |
| var sidebar = localStorage.getItem('mdbook-sidebar'); |
| |
| if (theme.startsWith('"') && theme.endsWith('"')) { |
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); |
| } |
| |
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { |
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); |
| } |
| } catch (e) { } |
| </script> |
| |
| <!-- Set the theme before any content is loaded, prevents flash --> |
| <script> |
| var theme; |
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } |
| if (theme === null || theme === undefined) { theme = default_theme; } |
| const html = document.documentElement; |
| html.classList.remove('light') |
| html.classList.add(theme); |
| html.classList.add("js"); |
| </script> |
| |
| <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> |
| |
| <!-- Hide / unhide sidebar before it is displayed --> |
| <script> |
| var sidebar = null; |
| var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); |
| if (document.body.clientWidth >= 1080) { |
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } |
| sidebar = sidebar || 'visible'; |
| } else { |
| sidebar = 'hidden'; |
| } |
| sidebar_toggle.checked = sidebar === 'visible'; |
| html.classList.remove('sidebar-visible'); |
| html.classList.add("sidebar-" + sidebar); |
| </script> |
| |
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> |
| <!-- populated by js --> |
| <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox> |
| <noscript> |
| <iframe class="sidebar-iframe-outer" src="toc.html"></iframe> |
| </noscript> |
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"> |
| <div class="sidebar-resize-indicator"></div> |
| </div> |
| </nav> |
| |
| <div id="page-wrapper" class="page-wrapper"> |
| |
| <div class="page"> |
| <div id="menu-bar-hover-placeholder"></div> |
| <div id="menu-bar" class="menu-bar sticky"> |
| <div class="left-buttons"> |
| <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> |
| <i class="fa fa-bars"></i> |
| </label> |
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> |
| <i class="fa fa-paint-brush"></i> |
| </button> |
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> |
| <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> |
| </ul> |
| <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> |
| <i class="fa fa-search"></i> |
| </button> |
| </div> |
| |
| <h1 class="menu-title">rules_rust</h1> |
| |
| <div class="right-buttons"> |
| <a href="print.html" title="Print this book" aria-label="Print this book"> |
| <i id="print-button" class="fa fa-print"></i> |
| </a> |
| <a href="https://github.com/bazelbuild/rules_rust" title="Git repository" aria-label="Git repository"> |
| <i id="git-repository-button" class="fa fa-github"></i> |
| </a> |
| |
| </div> |
| </div> |
| |
| <div id="search-wrapper" class="hidden"> |
| <form id="searchbar-outer" class="searchbar-outer"> |
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> |
| </form> |
| <div id="searchresults-outer" class="searchresults-outer hidden"> |
| <div id="searchresults-header" class="searchresults-header"></div> |
| <ul id="searchresults"> |
| </ul> |
| </div> |
| </div> |
| |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> |
| <script> |
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); |
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); |
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); |
| }); |
| </script> |
| |
| <div id="content" class="content"> |
| <main> |
| <!-- Generated with Stardoc: http://skydoc.bazel.build --> |
| <h1 id="rust-proto"><a class="header" href="#rust-proto">Rust Proto</a></h1> |
| <ul> |
| <li><a href="#rust_prost_library">rust_prost_library</a></li> |
| <li><a href="#rust_prost_toolchain">rust_prost_toolchain</a></li> |
| <li><a href="#rust_prost_dependencies">rust_prost_dependencies</a></li> |
| <li><a href="#rust_prost_transitive_repositories">rust_prost_transitive_repositories</a></li> |
| <li><a href="#rust_proto_library">rust_proto_library</a></li> |
| <li><a href="#rust_grpc_library">rust_grpc_library</a></li> |
| <li><a href="#rust_proto_protobuf_toolchain">rust_proto_protobuf_toolchain</a></li> |
| <li><a href="#rust_proto_protobuf_dependencies">rust_proto_protobuf_dependencies</a></li> |
| <li><a href="#rust_proto_protobuf_register_toolchains">rust_proto_protobuf_register_toolchains</a></li> |
| <li><a href="#rust_proto_protobuf_transitive_repositories">rust_proto_protobuf_transitive_repositories</a></li> |
| </ul> |
| <h2 id="overview"><a class="header" href="#overview">Overview</a></h2> |
| <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.</p> |
| <p>There are two rule sets. The first ruleset defines the <code>rust_prost_library</code> which generates Rust code |
| using 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. The second ruleset defines the <code>rust_proto_library</code> and |
| <code>rust_grpc_library</code> rules which generate Rust code using the <a href="https://github.com/stepancheg/rust-protobuf/"><code>rust-protobuf</code></a> dependencies.</p> |
| <p>See the <a href="../examples/proto">protobuf example</a> for a more complete example of use.</p> |
| <h3 id="prost-setup"><a class="header" href="#prost-setup">Prost Setup</a></h3> |
| <pre><code class="language-python">load("@rules_rust//proto/prost:repositories.bzl", "rust_prost_dependencies") |
| |
| rust_prost_dependencies() |
| |
| load("@rules_rust//proto/prost:transitive_repositories.bzl", "rust_prost_transitive_repositories") |
| |
| rust_prost_transitive_repositories() |
| </code></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 id="customizing-prost-and-tonic-dependencies"><a class="header" href="#customizing-prost-and-tonic-dependencies"><a name="custom-prost-deps">Customizing <code>prost</code> and <code>tonic</code> Dependencies</a></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="./crate_universe.html">crate_universe</a> repository |
| rules. For example:</p> |
| <pre><code class="language-python">load("//crate_universe:defs.bzl", "crate", "crates_repository") |
| |
| crates_repository( |
| name = "crates_io", |
| annotations = { |
| "protoc-gen-prost": [crate.annotation( |
| gen_binaries = ["protoc-gen-prost"], |
| patch_args = [ |
| "-p1", |
| ], |
| patches = [ |
| # Note: You will need to use this patch until a version greater than `0.2.2` of |
| # `protoc-gen-prost` is released. |
| "@rules_rust//proto/prost/private/3rdparty/patches:protoc-gen-prost.patch", |
| ], |
| )], |
| "protoc-gen-tonic": [crate.annotation( |
| gen_binaries = ["protoc-gen-tonic"], |
| )], |
| }, |
| cargo_lockfile = "Cargo.Bazel.lock", |
| mode = "remote", |
| packages = { |
| "prost": crate.spec( |
| version = "0", |
| ), |
| "prost-types": crate.spec( |
| version = "0", |
| ), |
| "protoc-gen-prost": crate.spec( |
| version = "0", |
| ), |
| "protoc-gen-tonic": crate.spec( |
| version = "0", |
| ), |
| "tonic": crate.spec( |
| version = "0", |
| ), |
| }, |
| repository_name = "rules_rust_prost", |
| tags = ["manual"], |
| ) |
| </code></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><code class="language-python">load("@rules_rust//proto/prost:defs.bzl", "rust_prost_toolchain") |
| load("@rules_rust//rust:defs.bzl", "rust_library_group") |
| |
| rust_library_group( |
| name = "prost_runtime", |
| deps = [ |
| "@crates_io//:prost", |
| ], |
| ) |
| |
| rust_library_group( |
| name = "tonic_runtime", |
| deps = [ |
| ":prost_runtime", |
| "@crates_io//:tonic", |
| ], |
| ) |
| |
| rust_prost_toolchain( |
| name = "prost_toolchain_impl", |
| prost_plugin = "@crates_io//:protoc-gen-prost__protoc-gen-prost", |
| prost_runtime = ":prost_runtime", |
| prost_types = "@crates_io//:prost-types", |
| proto_compiler = "@com_google_protobuf//:protoc", |
| tonic_plugin = "@crates_io//:protoc-gen-tonic__protoc-gen-tonic", |
| tonic_runtime = ":tonic_runtime", |
| ) |
| |
| toolchain( |
| name = "prost_toolchain", |
| toolchain = "prost_toolchain_impl", |
| toolchain_type = "@rules_rust//proto/prost:toolchain_type", |
| ) |
| </code></pre> |
| <p>Lastly, you must register the toolchain in your <code>WORKSPACE</code> file. For example:</p> |
| <pre><code class="language-python">register_toolchains("//toolchains:prost_toolchain") |
| </code></pre> |
| <h2 id="rust-protobuf-setup"><a class="header" href="#rust-protobuf-setup">Rust-Protobuf Setup</a></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="..">rust rules setup</a>):</p> |
| <pre><code class="language-python">load("@rules_rust//proto/protobuf:repositories.bzl", "rust_proto_protobuf_dependencies", "rust_proto_protobuf_register_toolchains") |
| |
| rust_proto_protobuf_dependencies() |
| |
| rust_proto_protobuf_register_toolchains() |
| |
| load("@rules_rust//proto/protobuf:transitive_repositories.bzl", "rust_proto_protobuf_transitive_repositories") |
| |
| rust_proto_protobuf_transitive_repositories() |
| </code></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 id="customizing-rust-protobuf-dependencies"><a class="header" href="#customizing-rust-protobuf-dependencies"><a name="custom-proto-deps">Customizing <code>rust-protobuf</code> Dependencies</a></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="./crate_universe.html">crate_universe</a>.</p> |
| <p>If you want to either change the protobuf and gRPC rust compilers, or to |
| simply use <a href="./crate_universe.html">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><code class="language-python">load("@rules_rust//proto:toolchain.bzl", "rust_proto_toolchain") |
| |
| rust_proto_toolchain( |
| name = "proto-toolchain-impl", |
| # Path to the protobuf compiler. |
| protoc = "@com_google_protobuf//:protoc", |
| # Protobuf compiler plugin to generate rust gRPC stubs. |
| grpc_plugin = "//3rdparty/crates:cargo_bin_protoc_gen_rust_grpc", |
| # Protobuf compiler plugin to generate rust protobuf stubs. |
| proto_plugin = "//3rdparty/crates:cargo_bin_protoc_gen_rust", |
| ) |
| |
| toolchain( |
| name = "proto-toolchain", |
| toolchain = ":proto-toolchain-impl", |
| toolchain_type = "@rules_rust//proto/protobuf:toolchain_type", |
| ) |
| </code></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><code class="language-python">register_toolchains("//my/toolchains:proto-toolchain") |
| </code></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><code class="language-python">rust_proto_library( |
| ... |
| rust_deps = ["//3rdparty/crates:protobuf"], |
| ... |
| ) |
| |
| rust_grpc_library( |
| ... |
| rust_deps = [ |
| "//3rdparty/crates:protobuf", |
| "//3rdparty/crates:grpc", |
| "//3rdparty/crates:tls_api", |
| "//3rdparty/crates:tls_api_stub", |
| ], |
| ... |
| ) |
| </code></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><a id="rust_grpc_library"></a></p> |
| <h2 id="rust_grpc_library"><a class="header" href="#rust_grpc_library">rust_grpc_library</a></h2> |
| <pre> |
| rust_grpc_library(<a href="#rust_grpc_library-name">name</a>, <a href="#rust_grpc_library-deps">deps</a>, <a href="#rust_grpc_library-crate_name">crate_name</a>, <a href="#rust_grpc_library-rust_deps">rust_deps</a>, <a href="#rust_grpc_library-rustc_flags">rustc_flags</a>) |
| </pre> |
| <p>Builds a Rust library crate from a set of <code>proto_library</code>s suitable for gRPC.</p> |
| <p>Example:</p> |
| <pre><code class="language-python">load("@rules_rust//proto/protobuf:defs.bzl", "rust_grpc_library") |
| |
| proto_library( |
| name = "my_proto", |
| srcs = ["my.proto"] |
| ) |
| |
| rust_grpc_library( |
| name = "rust", |
| deps = [":my_proto"], |
| ) |
| |
| rust_binary( |
| name = "my_service", |
| srcs = ["my_service.rs"], |
| deps = [":rust"], |
| ) |
| </code></pre> |
| <p><strong>ATTRIBUTES</strong></p> |
| <div class="table-wrapper"><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"><a id="rust_grpc_library-name"></a>name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels#target-names">Name</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_grpc_library-deps"></a>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"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_grpc_library-crate_name"></a>crate_name</td><td style="text-align: left">Crate name to use for this target.<br><br>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"><a id="rust_grpc_library-rust_deps"></a>rust_deps</td><td style="text-align: left">The crates the generated library depends on.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr> |
| <tr><td style="text-align: left"><a id="rust_grpc_library-rustc_flags"></a>rustc_flags</td><td style="text-align: left">List of compiler flags passed to <code>rustc</code>.<br><br>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> |
| </div> |
| <p><a id="rust_prost_toolchain"></a></p> |
| <h2 id="rust_prost_toolchain"><a class="header" href="#rust_prost_toolchain">rust_prost_toolchain</a></h2> |
| <pre> |
| rust_prost_toolchain(<a href="#rust_prost_toolchain-name">name</a>, <a href="#rust_prost_toolchain-include_transitive_deps">include_transitive_deps</a>, <a href="#rust_prost_toolchain-prost_opts">prost_opts</a>, <a href="#rust_prost_toolchain-prost_plugin">prost_plugin</a>, <a href="#rust_prost_toolchain-prost_plugin_flag">prost_plugin_flag</a>, |
| <a href="#rust_prost_toolchain-prost_runtime">prost_runtime</a>, <a href="#rust_prost_toolchain-prost_types">prost_types</a>, <a href="#rust_prost_toolchain-proto_compiler">proto_compiler</a>, <a href="#rust_prost_toolchain-tonic_opts">tonic_opts</a>, <a href="#rust_prost_toolchain-tonic_plugin">tonic_plugin</a>, |
| <a href="#rust_prost_toolchain-tonic_plugin_flag">tonic_plugin_flag</a>, <a href="#rust_prost_toolchain-tonic_runtime">tonic_runtime</a>) |
| </pre> |
| <p>Rust Prost toolchain rule.</p> |
| <p><strong>ATTRIBUTES</strong></p> |
| <div class="table-wrapper"><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"><a id="rust_prost_toolchain-name"></a>name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels#target-names">Name</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_prost_toolchain-include_transitive_deps"></a>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"><a id="rust_prost_toolchain-prost_opts"></a>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"><a id="rust_prost_toolchain-prost_plugin"></a>prost_plugin</td><td style="text-align: left">Additional plugins to add to Prost.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_prost_toolchain-prost_plugin_flag"></a>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"><a id="rust_prost_toolchain-prost_runtime"></a>prost_runtime</td><td style="text-align: left">The Prost runtime crates to use.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_prost_toolchain-prost_types"></a>prost_types</td><td style="text-align: left">The Prost types crates to use.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_prost_toolchain-proto_compiler"></a>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"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr> |
| <tr><td style="text-align: left"><a id="rust_prost_toolchain-tonic_opts"></a>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"><a id="rust_prost_toolchain-tonic_plugin"></a>tonic_plugin</td><td style="text-align: left">Additional plugins to add to Tonic.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr> |
| <tr><td style="text-align: left"><a id="rust_prost_toolchain-tonic_plugin_flag"></a>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"><a id="rust_prost_toolchain-tonic_runtime"></a>tonic_runtime</td><td style="text-align: left">The Tonic runtime crates to use.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr> |
| </tbody></table> |
| </div> |
| <p><a id="rust_proto_library"></a></p> |
| <h2 id="rust_proto_library"><a class="header" href="#rust_proto_library">rust_proto_library</a></h2> |
| <pre> |
| rust_proto_library(<a href="#rust_proto_library-name">name</a>, <a href="#rust_proto_library-deps">deps</a>, <a href="#rust_proto_library-crate_name">crate_name</a>, <a href="#rust_proto_library-rust_deps">rust_deps</a>, <a href="#rust_proto_library-rustc_flags">rustc_flags</a>) |
| </pre> |
| <p>Builds a Rust library crate from a set of <code>proto_library</code>s.</p> |
| <p>Example:</p> |
| <pre><code class="language-python">load("@rules_rust//proto/protobuf:defs.bzl", "rust_proto_library") |
| |
| proto_library( |
| name = "my_proto", |
| srcs = ["my.proto"] |
| ) |
| |
| rust_proto_library( |
| name = "rust", |
| deps = [":my_proto"], |
| ) |
| |
| rust_binary( |
| name = "my_proto_binary", |
| srcs = ["my_proto_binary.rs"], |
| deps = [":rust"], |
| ) |
| </code></pre> |
| <p><strong>ATTRIBUTES</strong></p> |
| <div class="table-wrapper"><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"><a id="rust_proto_library-name"></a>name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels#target-names">Name</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_proto_library-deps"></a>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"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr> |
| <tr><td style="text-align: left"><a id="rust_proto_library-crate_name"></a>crate_name</td><td style="text-align: left">Crate name to use for this target.<br><br>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"><a id="rust_proto_library-rust_deps"></a>rust_deps</td><td style="text-align: left">The crates the generated library depends on.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr> |
| <tr><td style="text-align: left"><a id="rust_proto_library-rustc_flags"></a>rustc_flags</td><td style="text-align: left">List of compiler flags passed to <code>rustc</code>.<br><br>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> |
| </div> |
| <p><a id="rust_prost_dependencies"></a></p> |
| <h2 id="rust_prost_dependencies"><a class="header" href="#rust_prost_dependencies">rust_prost_dependencies</a></h2> |
| <pre> |
| rust_prost_dependencies(<a href="#rust_prost_dependencies-bzlmod">bzlmod</a>) |
| </pre> |
| <p>Declares repositories needed for prost.</p> |
| <p><strong>PARAMETERS</strong></p> |
| <div class="table-wrapper"><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"><a id="rust_prost_dependencies-bzlmod"></a>bzlmod</td><td style="text-align: left">Whether bzlmod is enabled.</td><td style="text-align: left"><code>False</code></td></tr> |
| </tbody></table> |
| </div> |
| <p><strong>RETURNS</strong></p> |
| <p>list[struct(repo=str, is_dev_dep=bool)]: A list of the repositories |
| defined by this macro.</p> |
| <p><a id="rust_prost_library"></a></p> |
| <h2 id="rust_prost_library"><a class="header" href="#rust_prost_library">rust_prost_library</a></h2> |
| <pre> |
| rust_prost_library(<a href="#rust_prost_library-name">name</a>, <a href="#rust_prost_library-kwargs">kwargs</a>) |
| </pre> |
| <p>A rule for generating a Rust library using Prost.</p> |
| <p><strong>PARAMETERS</strong></p> |
| <div class="table-wrapper"><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"><a id="rust_prost_library-name"></a>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"><a id="rust_prost_library-kwargs"></a>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> |
| </div> |
| <p><a id="rust_prost_transitive_repositories"></a></p> |
| <h2 id="rust_prost_transitive_repositories"><a class="header" href="#rust_prost_transitive_repositories">rust_prost_transitive_repositories</a></h2> |
| <pre> |
| rust_prost_transitive_repositories() |
| </pre> |
| <p>Load transitive dependencies of the <code>@rules_rust//proto/protobuf</code> rules.</p> |
| <p>This macro should be called immediately after the <code>rust_protobuf_dependencies</code> macro.</p> |
| <p><a id="rust_proto_protobuf_dependencies"></a></p> |
| <h2 id="rust_proto_protobuf_dependencies"><a class="header" href="#rust_proto_protobuf_dependencies">rust_proto_protobuf_dependencies</a></h2> |
| <pre> |
| rust_proto_protobuf_dependencies(<a href="#rust_proto_protobuf_dependencies-bzlmod">bzlmod</a>) |
| </pre> |
| <p>Sets up dependencies for rules_rust's proto support.</p> |
| <p><strong>PARAMETERS</strong></p> |
| <div class="table-wrapper"><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"><a id="rust_proto_protobuf_dependencies-bzlmod"></a>bzlmod</td><td style="text-align: left">Whether this function is being called from a bzlmod context rather than a workspace context.</td><td style="text-align: left"><code>False</code></td></tr> |
| </tbody></table> |
| </div> |
| <p><strong>RETURNS</strong></p> |
| <p>A list of structs containing information about root module deps to report to bzlmod's extension_metadata.</p> |
| <p><a id="rust_proto_protobuf_register_toolchains"></a></p> |
| <h2 id="rust_proto_protobuf_register_toolchains"><a class="header" href="#rust_proto_protobuf_register_toolchains">rust_proto_protobuf_register_toolchains</a></h2> |
| <pre> |
| rust_proto_protobuf_register_toolchains(<a href="#rust_proto_protobuf_register_toolchains-register_toolchains">register_toolchains</a>) |
| </pre> |
| <p>Register toolchains for proto compilation.</p> |
| <p><strong>PARAMETERS</strong></p> |
| <div class="table-wrapper"><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"><a id="rust_proto_protobuf_register_toolchains-register_toolchains"></a>register_toolchains</td><td style="text-align: left"><p align="center"> - </p></td><td style="text-align: left"><code>True</code></td></tr> |
| </tbody></table> |
| </div> |
| <p><a id="rust_proto_protobuf_transitive_repositories"></a></p> |
| <h2 id="rust_proto_protobuf_transitive_repositories"><a class="header" href="#rust_proto_protobuf_transitive_repositories">rust_proto_protobuf_transitive_repositories</a></h2> |
| <pre> |
| rust_proto_protobuf_transitive_repositories() |
| </pre> |
| <p>Load transitive dependencies of the <code>@rules_rust//proto/protobuf</code> rules.</p> |
| <p>This macro should be called immediately after the <code>rust_protobuf_dependencies</code> macro.</p> |
| |
| </main> |
| |
| <nav class="nav-wrapper" aria-label="Page navigation"> |
| <!-- Mobile navigation buttons --> |
| <a rel="prev" href="rust_fmt.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| <a rel="next prefetch" href="rust_bindgen.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| |
| <div style="clear: both"></div> |
| </nav> |
| </div> |
| </div> |
| |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> |
| <a rel="prev" href="rust_fmt.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| <a rel="next prefetch" href="rust_bindgen.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| </nav> |
| |
| </div> |
| |
| |
| |
| |
| <script> |
| window.playground_copyable = true; |
| </script> |
| |
| |
| <script src="elasticlunr.min.js"></script> |
| <script src="mark.min.js"></script> |
| <script src="searcher.js"></script> |
| |
| <script src="clipboard.min.js"></script> |
| <script src="highlight.js"></script> |
| <script src="book.js"></script> |
| |
| <!-- Custom JS scripts --> |
| |
| |
| </div> |
| </body> |
| </html> |
