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.

Rules#
Rule	Description
rust_prost_proto_compile	Generates Rust protobuf `.rs` files using prost
rust_tonic_grpc_compile	Generates Rust protobuf and gRPC `.rs` files using prost and tonic
rust_prost_proto_library	Generates a Rust prost protobuf library using `rust_library` from `rules_rust`
rust_tonic_grpc_library	Generates a Rust prost protobuf and tonic gRPC library using `rust_library` from `rules_rust`

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#

Attributes for rust_prost_proto_compile#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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#

Attributes for rust_tonic_grpc_compile#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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#

Attributes for rust_prost_proto_library#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`prost_deps`	`label_list`	false	`["//rust/crates:prost", "//rust/crates:prost-types"]`	The prost dependencies that the rust library should depend on.
`prost_derive_dep`	`label`	false	`//rust/crates:prost-derive`	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#

Attributes for rust_tonic_grpc_library#
Name	Type	Mandatory	Default	Description
`protos`	`label_list`	true		List of labels that provide the `ProtoInfo` provider (such as `proto_library` from `rules_proto`)
`options`	`string_list_dict`	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
`verbose`	`int`	false	`0`	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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`string_list`	false	`[]`	A list of extra command line arguments to pass directly to protoc, not as plugin options
`extra_protoc_files`	`label_list`	false	`[]`	List of labels that provide extra files to be available during protoc execution
`output_mode`	`string`	false	`PREFIXED`	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
`deps`	`label_list`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`prost_deps`	`label_list`	false	`["//rust/crates:prost", "//rust/crates:prost-types"]`	The prost dependencies that the rust library should depend on.
`prost_derive_dep`	`label`	false	`//rust/crates:prost-derive`	The prost-derive dependency that the rust library should depend on.
`tonic_deps`	`label`	false	`[//rust/crates:tonic]`	The tonic dependencies that the rust library should depend on.

Rust#

rust_prost_proto_compile#

Example#

WORKSPACE#

BUILD.bazel#

Attributes#

Plugins#

rust_tonic_grpc_compile#

Example#

WORKSPACE#

BUILD.bazel#

Attributes#

Plugins#

rust_prost_proto_library#

Example#

WORKSPACE#

BUILD.bazel#

Attributes#

rust_tonic_grpc_library#

Example#

WORKSPACE#

BUILD.bazel#

Attributes#

`WORKSPACE`#

`BUILD.bazel`#

`WORKSPACE`#

`BUILD.bazel`#

`WORKSPACE`#

`BUILD.bazel`#

`WORKSPACE`#

`BUILD.bazel`#