Objective-C#
Rules for generating Objective-C protobuf and gRPC .m
& .h
files and libraries using standard Protocol Buffers and gRPC. Libraries are created with the Bazel native objc_library
Rule |
Description |
---|---|
Generates Objective-C protobuf |
|
Generates Objective-C protobuf and gRPC |
|
Generates an Objective-C protobuf library using |
|
Generates an Objective-C protobuf and gRPC library using |
objc_proto_compile#
Generates Objective-C protobuf .m
& .h
files
Example#
Full example project can be found here
BUILD.bazel
#
load("@rules_proto_grpc_objc//:defs.bzl", "objc_proto_compile")
objc_proto_compile(
name = "person_objc_proto",
protos = ["@rules_proto_grpc_example_protos//:person_proto"],
)
objc_proto_compile(
name = "place_objc_proto",
protos = ["@rules_proto_grpc_example_protos//:place_proto"],
)
objc_proto_compile(
name = "thing_objc_proto",
protos = ["@rules_proto_grpc_example_protos//: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#
objc_grpc_compile#
Generates Objective-C protobuf and gRPC .m
& .h
files
Example#
Full example project can be found here
BUILD.bazel
#
load("@rules_proto_grpc_objc//:defs.bzl", "objc_grpc_compile")
objc_grpc_compile(
name = "thing_objc_grpc",
protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)
objc_grpc_compile(
name = "greeter_objc_grpc",
protos = ["@rules_proto_grpc_example_protos//: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#
objc_proto_library#
Generates an Objective-C protobuf library using objc_library
Example#
Full example project can be found here
BUILD.bazel
#
load("@rules_proto_grpc_objc//:defs.bzl", "objc_proto_library")
objc_proto_library(
name = "person_objc_proto",
protos = ["@rules_proto_grpc_example_protos//:person_proto"],
deps = ["place_objc_proto"],
)
objc_proto_library(
name = "place_objc_proto",
protos = ["@rules_proto_grpc_example_protos//:place_proto"],
deps = ["thing_objc_proto"],
)
objc_proto_library(
name = "thing_objc_proto",
protos = ["@rules_proto_grpc_example_protos//: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 |
objc_grpc_library#
Warning
This rule is experimental. It may not work correctly or may change in future releases!
Generates an Objective-C protobuf and gRPC library using objc_library
Example#
Full example project can be found here
BUILD.bazel
#
load("@rules_proto_grpc_objc//:defs.bzl", "objc_grpc_library")
objc_grpc_library(
name = "thing_objc_grpc",
protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)
objc_grpc_library(
name = "greeter_objc_grpc",
protos = ["@rules_proto_grpc_example_protos//:greeter_grpc"],
deps = ["thing_objc_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 |