C++#
Rules for generating C++ protobuf and gRPC .cc
& .h
files and libraries using standard Protocol Buffers and gRPC. Libraries are created with the Bazel native cc_library
Rule |
Description |
---|---|
Generates C++ protobuf |
|
Generates C++ protobuf and gRPC |
|
Generates a C++ protobuf library using |
|
Generates a C++ protobuf and gRPC library using |
cpp_proto_compile#
Generates C++ protobuf .h
& .cc
files
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//cpp:repositories.bzl", rules_proto_grpc_cpp_repos = "cpp_repos")
rules_proto_grpc_cpp_repos()
BUILD.bazel
#
load("@rules_proto_grpc//cpp:defs.bzl", "cpp_proto_compile")
cpp_proto_compile(
name = "person_cpp_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
)
cpp_proto_compile(
name = "place_cpp_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
)
cpp_proto_compile(
name = "thing_cpp_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 |
Plugins#
cpp_grpc_compile#
Generates C++ protobuf and gRPC .h
& .cc
files
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//cpp:repositories.bzl", rules_proto_grpc_cpp_repos = "cpp_repos")
rules_proto_grpc_cpp_repos()
load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")
grpc_deps()
load("@com_github_grpc_grpc//bazel:grpc_extra_deps.bzl", "grpc_extra_deps")
grpc_extra_deps()
BUILD.bazel
#
load("@rules_proto_grpc//cpp:defs.bzl", "cpp_grpc_compile")
cpp_grpc_compile(
name = "thing_cpp_grpc",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
cpp_grpc_compile(
name = "greeter_cpp_grpc",
protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
)
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#
cpp_proto_library#
Generates a C++ protobuf library using cc_library
, with dependencies linked
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//cpp:repositories.bzl", rules_proto_grpc_cpp_repos = "cpp_repos")
rules_proto_grpc_cpp_repos()
BUILD.bazel
#
load("@rules_proto_grpc//cpp:defs.bzl", "cpp_proto_library")
cpp_proto_library(
name = "person_cpp_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
deps = ["place_cpp_proto"],
)
cpp_proto_library(
name = "place_cpp_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
deps = ["thing_cpp_proto"],
)
cpp_proto_library(
name = "thing_cpp_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 |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
cpp_grpc_library#
Generates a C++ protobuf and gRPC library using cc_library
, with dependencies linked
Example#
Full example project can be found here
WORKSPACE
#
load("@rules_proto_grpc//cpp:repositories.bzl", rules_proto_grpc_cpp_repos = "cpp_repos")
rules_proto_grpc_cpp_repos()
load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")
grpc_deps()
load("@com_github_grpc_grpc//bazel:grpc_extra_deps.bzl", "grpc_extra_deps")
grpc_extra_deps()
BUILD.bazel
#
load("@rules_proto_grpc//cpp:defs.bzl", "cpp_grpc_library")
cpp_grpc_library(
name = "thing_cpp_grpc",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
cpp_grpc_library(
name = "greeter_cpp_grpc",
protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
deps = ["thing_cpp_grpc"],
)
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 |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |
|
|
false |
|
Passed to the |