प्रोटोकॉल बफ़र के नियम

नियम

• proto_lang_toolchain
• proto_library

proto_lang_toolchain

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

अगर Bazel का इस्तेमाल किया जा रहा है, तो कृपया https://github.com/bazelbuild/rules_proto से नियम लोड करें.

इससे यह तय होता है कि LANG_proto_library नियम (जैसे, java_proto_library) को proto-कंपाइलर को कैसे कॉल करना चाहिए. कुछ LANG_proto_library नियमों में, कमांड-लाइन फ़्लैग का इस्तेमाल करके यह तय किया जा सकता है कि किस टूलचेन का इस्तेमाल करना है. ज़्यादा जानकारी के लिए, उनसे जुड़े दस्तावेज़ देखें.

आम तौर पर, आपको इस तरह के नियम नहीं लिखने चाहिए. हालांकि, अगर आपको Java कंपाइलर को ट्यून करना है, तो नियम लिखे जा सकते हैं.

कोई कंपाइलर नहीं है. proto-कंपाइलर, उस proto_library नियम से लिया जाता है जिसे हम जोड़ते हैं. इसे Blaze को कमांड-लाइन फ़्लैग के तौर पर पास किया जाता है. कई सुविधाओं के लिए, proto_library नियम पर proto-कंपाइलर को कॉल करना ज़रूरी होता है. यह ज़रूरी है कि LANG_proto_library जिस कंपाइलर का इस्तेमाल करता है वह वही हो जिसका इस्तेमाल proto_library करता है.

उदाहरण

यहां एक आसान उदाहरण दिया गया है:

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

तर्क

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, visibility)

अब इस्तेमाल में नहीं है. कृपया इसके बजाय, https://github.com/bazelbuild/rules_proto का इस्तेमाल करें.

प्रोटोकॉल बफ़र की लाइब्रेरी तय करने के लिए, proto_library का इस्तेमाल करें जिनका इस्तेमाल एक से ज़्यादा भाषाओं में किया जा सकता है. proto_library को, काम करने वाले नियमों की deps क्लॉज़ में शामिल किया जा सकता है . जैसे, java_proto_library.

कमांड-लाइन पर कंपाइल करने पर, एक proto_library एक फ़ाइल बनाता है. इसका नाम foo-descriptor-set.proto.bin होता है. यह उन मैसेज के लिए डिस्क्रिप्टर सेट होता है जो नियम srcs होते हैं. यह फ़ाइल, क्रम से लगाई गई FileDescriptorSet होती है. इसके बारे में https://developers.google.com/protocol-buffers/docs/techniques#self-description में बताया गया है.

इसमें सिर्फ़ उन .proto फ़ाइलों की जानकारी होती है जिनका सीधे तौर पर proto_library नियम में ज़िक्र किया गया है. ट्रांज़िटिव डिस्क्रिप्टर सेट का कलेक्शन, [ProtoInfo].transitive_descriptor_sets Starlark प्रोवाइडर के ज़रिए उपलब्ध होता है. ProtoInfo.java में मौजूद दस्तावेज़ देखें.

कोड को व्यवस्थित करने का सुझाया गया तरीका:

• हर .proto फ़ाइल के लिए एक proto_library नियम.
• foo.proto नाम की फ़ाइल, foo_proto नाम के नियम में होगी. यह नियम, उसी पैकेज में मौजूद होगा.
• [language]_proto_library नाम के proto_library को रैप करने वाले foo_proto को foo_[language]_proto कहा जाना चाहिए. साथ ही, यह उसी पैकेज में मौजूद होना चाहिए.

तर्क