Regras de buffer de protocolo

Regras

• cc_proto_library
• java_lite_proto_library
• java_proto_library
• proto_library
• py_proto_library
• proto_lang_toolchain
• proto_toolchain

cc_proto_library

cc_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

cc_proto_library gera código C++ de arquivos .proto.

O deps precisa apontar para regras proto_library .

Exemplo:

cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

Argumentos

java_lite_proto_library

java_lite_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library gera código Java a partir de arquivos .proto.

O deps precisa apontar para regras proto_library .

Exemplo:

java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

Argumentos

java_proto_library

java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library gera código Java a partir de arquivos .proto.

O deps precisa apontar para regras proto_library .

Exemplo:

java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

Argumentos

proto_library

proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, import_prefix, licenses, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, toolchains, visibility)

Se você estiver usando o Bazel, carregue a regra em https://github.com/bazelbuild/rules_proto.

Use proto_library para definir bibliotecas de buffers de protocolo que podem ser usadas em vários idiomas. Um proto_library pode ser listado na cláusula deps de regras com suporte, como java_proto_library.

Quando compilado na linha de comando, um proto_library cria um arquivo chamado foo-descriptor-set.proto.bin, que é o descritor definido para as mensagens das srcs de regras. O arquivo é um FileDescriptorSet serializado, descrito em https://developers.google.com/protocol-buffers/docs/techniques#self-description.

Ele contém apenas informações sobre os arquivos .proto mencionados diretamente por uma regra proto_library. A coleta de conjuntos de descritores transitivos está disponível pelo provedor [ProtoInfo].transitive_descriptor_sets Starlark. Consulte a documentação em proto_info.bzl.

Organização de código recomendada:

• Uma regra proto_library por arquivo .proto.
• Um arquivo chamado foo.proto vai estar em uma regra chamada foo_proto, que está localizada no mesmo pacote.
• Um [language]_proto_library que envolve um proto_library chamado foo_proto precisa ser chamado de foo_[language]_proto e estar localizado no mesmo pacote.

Argumentos

py_proto_library

py_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

Argumentos

proto_lang_toolchain

proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)

Se você estiver usando o Bazel, carregue a regra em https://github.com/bazelbuild/rules_proto.

Especifica como uma regra LANG_proto_library (por exemplo, java_proto_library) precisa invocar o protocompilador. Algumas regras LANG_proto_library permitem especificar qual toolchain usar usando flags de linha de comando. Consulte a documentação delas.

Normalmente, não é necessário escrever esse tipo de regra, a menos que você queira ajustar seu compilador Java.

Não há compilador. O proto-compiler é retirado da regra proto_library a que nos conectamos. Ele é transmitido como uma flag de linha de comando para o Blaze. Vários recursos exigem que um proto-compiler seja invocado na própria regra proto_library. É benéfico forçar o compilador que LANG_proto_library usa a mesma que proto_library.

Exemplos

Um exemplo simples seria:

proto_lang_toolchain(
    name = "javalite_toolchain",
    command_line = "--javalite_out=shared,immutable:$(OUT)",
    plugin = ":javalite_plugin",
    runtime = ":protobuf_lite",
)

Argumentos

proto_toolchain

proto_toolchain(name, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

Argumentos