Rust#
Rules for generating Rust protobuf and gRPC .rs
files and libraries using prost and tonic. Libraries are created with rust_library
from rules_rust.
Rule |
Description |
---|---|
Generates Rust protobuf |
|
Generates Rust protobuf and gRPC |
|
Generates a Rust prost protobuf library using |
|
Generates a Rust prost protobuf and tonic gRPC library using |
rust_prost_proto_compile#
Generates Rust protobuf .rs
files using prost
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//rust:repositories.bzl", rules_proto_grpc_rust_repos = "rust_repos")
rules_proto_grpc_rust_repos()
load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")
grpc_deps()
load("@rules_rust//rust:repositories.bzl", "rules_rust_dependencies", "rust_register_toolchains")
rules_rust_dependencies()
rust_register_toolchains(edition = "2021")
load("@rules_rust//crate_universe:repositories.bzl", "crate_universe_dependencies")
crate_universe_dependencies(bootstrap = True)
load("@rules_proto_grpc//rust:crate_deps.bzl", "crate_repositories")
crate_repositories()
BUILD.bazel
#
load("@rules_proto_grpc//rust:defs.bzl", "rust_prost_proto_compile")
rust_prost_proto_compile(
name = "person_rust_proto",
declared_proto_packages = ["example.proto"],
options = {
"//rust:rust_prost_plugin": ["type_attribute=.other.space.Person=#[derive(Eq\\,Hash)]"],
},
protos = ["@rules_proto_grpc//example/proto:person_proto"],
)
rust_prost_proto_compile(
name = "place_rust_proto",
declared_proto_packages = ["example.proto"],
options = {
"//rust:rust_prost_plugin": ["type_attribute=.other.space.Place=#[derive(Eq\\,Hash)]"],
},
protos = ["@rules_proto_grpc//example/proto:place_proto"],
)
rust_prost_proto_compile(
name = "thing_rust_proto",
declared_proto_packages = ["example.proto"],
options = {
# Known limitation, can't derive if the type contains a pbjson type.
# "//rust:rust_prost_plugin": ["type_attribute=.other.space.Thing=#[derive(Eq\\,Hash)]"],
},
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
Attributes#
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra command line arguments to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins#
rust_tonic_grpc_compile#
Generates Rust protobuf and gRPC .rs
files using prost and tonic
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//rust:repositories.bzl", rules_proto_grpc_rust_repos = "rust_repos")
rules_proto_grpc_rust_repos()
load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")
grpc_deps()
load("@rules_rust//rust:repositories.bzl", "rules_rust_dependencies", "rust_register_toolchains")
rules_rust_dependencies()
rust_register_toolchains(edition = "2021")
load("@rules_rust//crate_universe:repositories.bzl", "crate_universe_dependencies")
crate_universe_dependencies(bootstrap = True)
load("@rules_proto_grpc//rust:crate_deps.bzl", "crate_repositories")
crate_repositories()
BUILD.bazel
#
load("@rules_proto_grpc//rust:defs.bzl", "rust_tonic_grpc_compile")
rust_tonic_grpc_compile(
name = "greeter_rust_grpc",
declared_proto_packages = ["example.proto"],
protos = [
"@rules_proto_grpc//example/proto:greeter_grpc",
"@rules_proto_grpc//example/proto:thing_proto",
],
)
Attributes#
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra command line arguments to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins#
rust_prost_proto_library#
Generates a Rust prost protobuf library using rust_library
from rules_rust
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//rust:repositories.bzl", rules_proto_grpc_rust_repos = "rust_repos")
rules_proto_grpc_rust_repos()
load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")
grpc_deps()
load("@rules_rust//rust:repositories.bzl", "rules_rust_dependencies", "rust_register_toolchains")
rules_rust_dependencies()
rust_register_toolchains(edition = "2021")
load("@rules_rust//crate_universe:repositories.bzl", "crate_universe_dependencies")
crate_universe_dependencies(bootstrap = True)
load("@rules_proto_grpc//rust:crate_deps.bzl", "crate_repositories")
crate_repositories()
BUILD.bazel
#
load("@rules_proto_grpc//rust:defs.bzl", "rust_prost_proto_library")
rust_prost_proto_library(
name = "person_place_rust_prost_proto",
declared_proto_packages = ["example.proto"],
options = {
"//rust:rust_prost_plugin": [
"type_attribute=.example.proto.Person=#[derive(Eq\\,Hash)]",
"type_attribute=.example.proto.Place=#[derive(Eq\\,Hash)]",
],
},
prost_proto_deps = [
":thing_rust_prost_proto",
],
protos = [
"@rules_proto_grpc//example/proto:person_proto",
"@rules_proto_grpc//example/proto:place_proto",
],
)
rust_prost_proto_library(
name = "thing_rust_prost_proto",
declared_proto_packages = ["example.proto"],
options = {
# Known limitation, can't derive if the type contains a pbjson type.
# "//rust:rust_prost_plugin": ["type_attribute=.example.proto.Thing=#[derive(Eq\\,Hash)]"],
},
protos = [
"@rules_proto_grpc//example/proto:thing_proto",
],
)
Attributes#
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra command line arguments to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
|
The prost dependencies that the rust library should depend on. |
|
|
false |
|
The prost-derive dependency that the rust library should depend on. |
rust_tonic_grpc_library#
Generates a Rust prost protobuf and tonic gRPC library using rust_library
from rules_rust
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//rust:repositories.bzl", rules_proto_grpc_rust_repos = "rust_repos")
rules_proto_grpc_rust_repos()
load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")
grpc_deps()
load("@rules_rust//rust:repositories.bzl", "rules_rust_dependencies", "rust_register_toolchains")
rules_rust_dependencies()
rust_register_toolchains(edition = "2021")
load("@rules_rust//crate_universe:repositories.bzl", "crate_universe_dependencies")
crate_universe_dependencies(bootstrap = True)
load("@rules_proto_grpc//rust:crate_deps.bzl", "crate_repositories")
crate_repositories()
BUILD.bazel
#
load("@rules_proto_grpc//rust:defs.bzl", "rust_prost_proto_library", "rust_tonic_grpc_library")
rust_tonic_grpc_library(
name = "greeter_rust_tonic_grpc",
declared_proto_packages = ["example.proto"],
options = {
"//rust:rust_prost_plugin": [
"type_attribute=.example.proto.Person=#[derive(Eq\\,Hash)]",
"type_attribute=.example.proto.Place=#[derive(Eq\\,Hash)]",
# "type_attribute=.example.proto.Thing=#[derive(Eq\\,Hash)]",
],
},
prost_proto_deps = [
":thing_prost",
],
protos = [
"@rules_proto_grpc//example/proto:greeter_grpc",
"@rules_proto_grpc//example/proto:person_proto",
"@rules_proto_grpc//example/proto:place_proto",
# "@rules_proto_grpc//example/proto:thing_proto",
],
)
# See https://github.com/rules-proto-grpc/rules_proto_grpc/pull/265/#issuecomment-1577920311
rust_prost_proto_library(
name = "thing_prost",
declared_proto_packages = ["example.proto"],
protos = [
"@rules_proto_grpc//example/proto:thing_proto",
],
)
Attributes#
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra command line arguments to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
|
The prost dependencies that the rust library should depend on. |
|
|
false |
|
The prost-derive dependency that the rust library should depend on. |
|
|
false |
|
The tonic dependencies that the rust library should depend on. |