Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://protobuf.dev/reference/cpp/api-docs/google.protobuf.descriptor below:

descriptor.h | Protocol Buffers Documentation

This section contains reference documentation for working with protocol buffer classes in C++.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

This file contains classes which describe a type of protocol message.

You can use a message's descriptor to learn at runtime what fields it contains and what the types of those fields are. The Message interface also allows you to dynamically access and modify individual fields by passing the FieldDescriptor of the field you are interested in.

Most users will not care about descriptors, because they will write code specific to certain protocol types and will simply use the classes generated by the protocol compiler directly. Advanced users who want to operate on arbitrary types (not known at compile time) may want to read descriptors in order to learn about the contents of a message. A very small number of users will want to construct their own Descriptors, either because they are implementing Message manually or because they are writing something like the protocol compiler.

For an example of how you might use descriptors, see the code example at the top of message.h.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

NB, all indices are zero-based.

start_line

end_line

start_column

end_column

Doc comments found at the source location.

See the comments in SourceCodeInfo.Location (descriptor.proto) for details.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Options when generating machine-parsable output from a descriptor with DebugString().

elide_group_body

If true, elide the braced body in the debug string.

elide_oneof_body

DebugStringOptions()

include original user comments as recorded in SourceLocation entries.

N.B. that this must be |false| by default: several other pieces of code (for example, the C++ code generation for fields in the proto compiler) rely on DebugString() output being unobstructed by user comments.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes a type of protocol message, or a particular group within a message.

To obtain the Descriptor for a given message object, call Message::GetDescriptor(). Generated message classes also have a static method called descriptor() which returns the type's descriptor. Use DescriptorPool to construct your own descriptors.

WellKnownType

DescriptorProto Proto

name() const

The name of the message type, not including its scope.

full_name() const

The fully-qualified name of the message type, scope delimited by periods.

index() const

Index of this descriptor within the file or containing type's message type array.

file() const

The .proto file in which this message type was defined. Never nullptr.

containing_type() const

If this

describes a nested type, this returns the type in which it is nested.

options() const

Get options for this message type.

CopyTo(DescriptorProto * proto) const

Write the contents of this

into the given DescriptorProto.

DebugString() const

Write the contents of this descriptor in a human-readable form.

Similar to

, but additionally takes options (e.g., include original user comments in output).

is_placeholder() const

Returns true if this is a placeholder for an unknown type.

well_known_type() const

field_count() const

The number of fields in this message type.

field(int index) const

Gets a field by index, where 0 <= index <

.

FindFieldByNumber(int number) const

Looks up a field by declared tag number.

FindFieldByName(ConstStringParam name) const

Looks up a field by name. Returns nullptr if no such field exists.

FindFieldByLowercaseName(ConstStringParam lowercase_name) const

Looks up a field by lowercased name (as returned by lowercase_name()).

FindFieldByCamelcaseName(ConstStringParam camelcase_name) const

Looks up a field by camel-case name (as returned by camelcase_name()).

oneof_decl_count() const

The number of oneofs in this message type.

real_oneof_decl_count() const

The number of oneofs in this message type, excluding synthetic oneofs.

oneof_decl(int index) const

Get a oneof by index, where 0 <= index <

.

FindOneofByName(ConstStringParam name) const

Looks up a oneof by name. Returns nullptr if no such oneof exists.

nested_type_count() const

The number of nested types in this message type.

nested_type(int index) const

Gets a nested type by index, where 0 <= index <

.

FindNestedTypeByName(ConstStringParam name) const

Looks up a nested type by name.

enum_type_count() const

The number of enum types in this message type.

enum_type(int index) const

Gets an enum type by index, where 0 <= index <

.

FindEnumTypeByName(ConstStringParam name) const

Looks up an enum type by name.

FindEnumValueByName(ConstStringParam name) const

Looks up an enum value by name, among all enum types in this message.

extension_range_count() const

The number of extension ranges in this message type.

extension_range(int index) const

Gets an extension range by index, where 0 <= index <

.

IsExtensionNumber(int number) const

Returns true if the number is in one of the extension ranges.

FindExtensionRangeContainingNumber(int number) const

Returns nullptr if no extension range contains the given number.

extension_count() const

The number of extensions defined nested within this message type's scope.

extension(int index) const

Get an extension by index, where 0 <= index <

.

FindExtensionByName(ConstStringParam name) const

Looks up a named extension (which extends some other message type) defined within this message type's scope.

FindExtensionByLowercaseName(ConstStringParam name) const

Similar to

, but finds extensions defined within this message type's scope.

FindExtensionByCamelcaseName(ConstStringParam name) const

Similar to

, but finds extensions defined within this message type's scope.

reserved_range_count() const

The number of reserved ranges in this message type.

reserved_range(int index) const

Gets an reserved range by index, where 0 <= index <

.

IsReservedNumber(int number) const

Returns true if the number is in one of the reserved ranges.

FindReservedRangeContainingNumber(int number) const

Returns nullptr if no reserved range contains the given number.

reserved_name_count() const

The number of reserved field names in this message type.

reserved_name(int index) const

Gets a reserved name by index, where 0 <= index <

.

IsReservedName(ConstStringParam name) const

Returns true if the field name is reserved.

Updates |*out_location| to the source location of the complete extent of this message declaration.

map_key() const

Returns the

for the "key" field.

map_value() const

Returns the

for the "value" field.

Wrapper types.

google.protobuf.DoubleValue

Other well known types.

google.protobuf.Any

New well-known types may be added in the future.

Please make sure any switch() statements have a 'default' case.

The fully-qualified name of the message type, scope delimited by periods.

For example, message type "Foo" which is declared in package "bar" has full name "bar.Foo". If a type "Baz" is nested within Foo, Baz's full_name is "bar.Foo.Baz". To get only the part that comes after the last '.', use name().

If this Descriptor describes a nested type, this returns the type in which it is nested.

Otherwise, returns nullptr.

Get options for this message type.

These are specified in the .proto file by placing lines like "option foo = 1234;" in the message definition. Allowed options are defined by MessageOptions in descriptor.proto, and any available extensions of that message.

Write the contents of this Descriptor into the given DescriptorProto.

The target DescriptorProto must be clear before calling this; if it isn't, the result may be garbage.

Write the contents of this descriptor in a human-readable form.

Output will be suitable for re-parsing.

Returns true if this is a placeholder for an unknown type.

This will only be the case if this descriptor comes from a DescriptorPool with AllowUnknownDependencies() set.

Gets a field by index, where 0 <= index < field_count().

These are returned in the order they were defined in the .proto file.

Looks up a field by declared tag number.

Returns nullptr if no such field exists.

Looks up a field by lowercased name (as returned by lowercase_name()).

This lookup may be ambiguous if multiple field names differ only by case, in which case the field returned is chosen arbitrarily from the matches.

Looks up a field by camel-case name (as returned by camelcase_name()).

This lookup may be ambiguous if multiple field names differ in a way that leads them to have identical camel-case names, in which case the field returned is chosen arbitrarily from the matches.

The number of oneofs in this message type, excluding synthetic oneofs.

Real oneofs always come first, so iterating up to real_oneof_decl_cout() will yield all real oneofs.

Get a oneof by index, where 0 <= index < oneof_decl_count().

These are returned in the order they were defined in the .proto file.

Gets a nested type by index, where 0 <= index < nested_type_count().

These are returned in the order they were defined in the .proto file.

Looks up a nested type by name.

Returns nullptr if no such nested type exists.

Gets an enum type by index, where 0 <= index < enum_type_count().

These are returned in the order they were defined in the .proto file.

Looks up an enum type by name.

Returns nullptr if no such enum type exists.

Looks up an enum value by name, among all enum types in this message.

Returns nullptr if no such value exists.

Gets an extension range by index, where 0 <= index < extension_range_count().

These are returned in the order they were defined in the .proto file.

Get an extension by index, where 0 <= index < extension_count().

These are returned in the order they were defined in the .proto file.

Gets an reserved range by index, where 0 <= index < reserved_range_count().

These are returned in the order they were defined in the .proto file.

Gets a reserved name by index, where 0 <= index < reserved_name_count().

Can't use PROTOBUF_DEFINE_ARRAY_ACCESSOR because reserved_names_ is actually an array of pointers rather than the usual array of objects.

Updates |*out_location| to the source location of the complete extent of this message declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

Returns the FieldDescriptor for the "key" field.

If this isn't a map entry field, returns nullptr.

Returns the FieldDescriptor for the "value" field.

If this isn't a map entry field, returns nullptr.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

A range of field numbers which are designated for third-party extensions.

DescriptorProto_ExtensionRange Proto

ExtensionRangeOptions OptionsType

start

inclusive

end

exclusive

options_

CopyTo(DescriptorProto_ExtensionRange * proto) const

See

.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

A range of reserved field numbers.

start

inclusive

end

exclusive

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes a single field of a message.

To get the descriptor for a given field, first get the Descriptor for the message in which it is defined, then call Descriptor::FindFieldByName(). To get a FieldDescriptor for an extension, do one of the following:

• Get the Descriptor or FileDescriptor for its containing scope, then call Descriptor::FindExtensionByName() or FileDescriptor::FindExtensionByName().
• Given a DescriptorPool, call DescriptorPool::FindExtensionByNumber() or DescriptorPool::FindExtensionByPrintableName(). Use DescriptorPool to construct your own descriptors.

Type

Identifies a field type.

CppType

Specifies the C++ data type used to represent the field.

Label

Identifies whether the field is optional, required, or repeated.

FieldDescriptorProto Proto

kMaxNumber = = (1 << 29) - 1

Valid field numbers are positive integers up to kMaxNumber.

kFirstReservedNumber = = 19000

First field number reserved for the protocol buffer library implementation.

kLastReservedNumber = = 19999

Last field number reserved for the protocol buffer library implementation.

default_value_int32_

default_value_int64_

default_value_uint32_

default_value_uint64_

default_value_float_

default_value_double_

default_value_bool_

default_value_enum_

default_value_string_

default_generated_instance_

name() const

Name of this field within the message.

full_name() const

Fully-qualified name of the field.

json_name() const

JSON name of this field.

file() const

File in which this field was defined.

is_extension() const

Is this an extension field?

number() const

Declared tag number.

lowercase_name() const

Same as

except converted to lower-case.

camelcase_name() const

Same as

except converted to camel-case.

type() const

Declared type of this field.

type_name() const

Name of the declared type.

cpp_type() const

C++ type of this field.

cpp_type_name() const

Name of the C++ type.

label() const

optional/required/repeated

is_required() const

shorthand for

== LABEL_REQUIRED

is_optional() const

shorthand for

== LABEL_OPTIONAL

is_repeated() const

shorthand for

== LABEL_REPEATED

is_packable() const

shorthand for

&& IsTypePackable(type())

is_packed() const

shorthand for

&&

.packed()

is_map() const

shorthand for

== TYPE_MESSAGE &&

->

.map_entry()

has_optional_keyword() const

Returns true if this field was syntactically written with "optional" in the .proto file.

has_presence() const

Returns true if this field tracks presence, ie.

index() const

Index of this field within the message's field array, or the file or extension scope's extensions array.

has_default_value() const

Does this field have an explicitly-declared default value?

has_json_name() const

Whether the user has specified the json_name field option in the .proto file.

default_value_int32() const

Get the field default value if

== CPPTYPE_INT32.

default_value_int64() const

Get the field default value if

== CPPTYPE_INT64.

default_value_uint32() const

Get the field default value if

== CPPTYPE_UINT32.

default_value_uint64() const

Get the field default value if

== CPPTYPE_UINT64.

default_value_float() const

Get the field default value if

== CPPTYPE_FLOAT.

default_value_double() const

Get the field default value if

== CPPTYPE_DOUBLE.

default_value_bool() const

Get the field default value if

== CPPTYPE_BOOL.

default_value_enum() const

Get the field default value if

== CPPTYPE_ENUM.

default_value_string() const

Get the field default value if

== CPPTYPE_STRING.

containing_type() const

The

for the message of which this is a field.

containing_oneof() const

If the field is a member of a oneof, this is the one, otherwise this is nullptr.

real_containing_oneof() const

If the field is a member of a non-synthetic oneof, returns the descriptor for the oneof, otherwise returns nullptr.

index_in_oneof() const

If the field is a member of a oneof, returns the index in that oneof.

extension_scope() const

An extension may be declared within the scope of another message.

message_type() const

If type is TYPE_MESSAGE or TYPE_GROUP, returns a descriptor for the message or the group type.

enum_type() const

If type is TYPE_ENUM, returns a descriptor for the enum.

options() const

Get the FieldOptions for this field.

CopyTo(FieldDescriptorProto * proto) const

See

.

DebugString() const

See

.

See

.

PrintableNameForExtension() const

Returns

except if the field is a MessageSet extension, in which case it returns the

of the containing message type for backwards compatibility with proto1.

Helper method to get the CppType for a particular Type.

Helper method to get the name of a Type.

Helper method to get the name of a CppType.

Return true iff [[]packed = true] is valid for fields of this type.

Updates |*out_location| to the source location of the complete extent of this field declaration.

Identifies a field type.

0 is reserved for errors. The order is weird for historical reasons. Types 12 and up are new in proto2.

int64, varint on the wire.

Negative numbers take 10 bytes. Use TYPE_SINT64 if negative values are likely.

int32, varint on the wire.

Negative numbers take 10 bytes. Use TYPE_SINT32 if negative values are likely.

Specifies the C++ data type used to represent the field.

There is a fixed mapping from Type to CppType where each Type maps to exactly one CppType. 0 is reserved for errors.

Identifies whether the field is optional, required, or repeated.

0 is reserved for errors.

First field number reserved for the protocol buffer library implementation.

Users may not declare fields that use reserved numbers.

Last field number reserved for the protocol buffer library implementation.

Users may not declare fields that use reserved numbers.

Same as name() except converted to lower-case.

This (and especially the FindFieldByLowercaseName() method) can be useful when parsing formats which prefer to use lowercase naming style. (Although, technically field names should be lowercased anyway according to the protobuf style guide, so this only makes a difference when dealing with old .proto files which do not follow the guide.)

Same as name() except converted to camel-case.

In this conversion, any time an underscore appears in the name, it is removed and the next letter is capitalized. Furthermore, the first letter of the name is lower-cased. Examples:

FooBar -> fooBar
foo_bar -> fooBar
fooBar -> fooBar

This (and especially the FindFieldByCamelcaseName() method) can be useful when parsing formats which prefer to use camel-case naming style.

Returns true if this field was syntactically written with "optional" in the .proto file.

Excludes singular proto3 fields that do not have a label.

Returns true if this field tracks presence, ie.

does the field distinguish between "unset" and "present with default value." This includes required, optional, and oneof fields. It excludes maps, repeated fields, and singular proto3 fields without "optional".

For fields where has_presence() == true, the return value of Reflection::HasField() is semantically meaningful.

Get the field default value if cpp_type() == CPPTYPE_INT32.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_INT64.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_UINT32.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_UINT64.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_FLOAT.

If no explicit default was defined, the default is 0.0.

Get the field default value if cpp_type() == CPPTYPE_DOUBLE.

If no explicit default was defined, the default is 0.0.

Get the field default value if cpp_type() == CPPTYPE_BOOL.

If no explicit default was defined, the default is false.

Get the field default value if cpp_type() == CPPTYPE_ENUM.

If no explicit default was defined, the default is the first value defined in the enum type (all enum types are required to have at least one value). This never returns nullptr.

Get the field default value if cpp_type() == CPPTYPE_STRING.

If no explicit default was defined, the default is the empty string.

The Descriptor for the message of which this is a field.

For extensions, this is the extended type. Never nullptr.

An extension may be declared within the scope of another message.

If this field is an extension (is_extension() is true), then extension_scope() returns that message, or nullptr if the extension was declared at global scope. If this is not an extension, extension_scope() is undefined (may assert-fail).

If type is TYPE_MESSAGE or TYPE_GROUP, returns a descriptor for the message or the group type.

Otherwise, returns null.

If type is TYPE_ENUM, returns a descriptor for the enum.

Otherwise, returns null.

Get the FieldOptions for this field.

This includes things listed in square brackets after the field definition. E.g., the field:

optional string text = 1 [[]ctype=CORD];

has the "ctype" option set. Allowed options are defined by FieldOptions in descriptor.proto, and any available extensions of that message.

Returns full_name() except if the field is a MessageSet extension, in which case it returns the full_name() of the containing message type for backwards compatibility with proto1.

A MessageSet extension is defined as an optional message extension whose containing type has the message_set_wire_format option set. This should be true of extensions of google.protobuf.bridge.MessageSet; by convention, such extensions are named "message_set_extension".

The opposite operation (looking up an extension's FieldDescriptor given its printable name) can be accomplished with

message->file()->pool()->FindExtensionByPrintableName(message, name)

where the extension extends "message".

Updates |*out_location| to the source location of the complete extent of this field declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes a oneof defined in a message type.

OneofDescriptorProto Proto

name() const

Name of this oneof.

full_name() const

Fully-qualified name of the oneof.

index() const

Index of this oneof within the message's oneof array.

is_synthetic() const

Returns whether this oneof was inserted by the compiler to wrap a proto3 optional field.

file() const

The .proto file in which this oneof was defined. Never nullptr.

containing_type() const

The

for the message containing this oneof.

field_count() const

The number of (non-extension) fields which are members of this oneof.

field(int index) const

Get a member of this oneof, in the order in which they were declared in the .proto file.

options() const

CopyTo(OneofDescriptorProto * proto) const

See

.

DebugString() const

See

.

See

.

Updates |*out_location| to the source location of the complete extent of this oneof declaration.

Returns whether this oneof was inserted by the compiler to wrap a proto3 optional field.

If this returns true, code generators should not emit it.

Get a member of this oneof, in the order in which they were declared in the .proto file.

Can't use PROTOBUF_DEFINE_ARRAY_ACCESSOR because fields_ is actually an array of pointers rather than the usual array of objects.

Does not include extensions.

Updates |*out_location| to the source location of the complete extent of this oneof declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes an enum type defined in a .proto file.

To get the EnumDescriptor for a generated enum type, call TypeName_descriptor(). Use DescriptorPool to construct your own descriptors.

EnumDescriptorProto Proto

name() const

The name of this enum type in the containing scope.

full_name() const

The fully-qualified name of the enum type, scope delimited by periods.

index() const

Index of this enum within the file or containing message's enum array.

file() const

The .proto file in which this enum type was defined. Never nullptr.

value_count() const

The number of values for this

.

value(int index) const

Gets a value by index, where 0 <= index <

.

FindValueByName(ConstStringParam name) const

Looks up a value by name. Returns nullptr if no such value exists.

FindValueByNumber(int number) const

Looks up a value by number.

containing_type() const

If this enum type is nested in a message type, this is that message type.

options() const

Get options for this enum type.

CopyTo(EnumDescriptorProto * proto) const

See

.

DebugString() const

See

.

See

.

is_placeholder() const

Returns true if this is a placeholder for an unknown enum.

reserved_range_count() const

The number of reserved ranges in this message type.

reserved_range(int index) const

Gets an reserved range by index, where 0 <= index <

.

IsReservedNumber(int number) const

Returns true if the number is in one of the reserved ranges.

FindReservedRangeContainingNumber(int number) const

Returns nullptr if no reserved range contains the given number.

reserved_name_count() const

The number of reserved field names in this message type.

reserved_name(int index) const

Gets a reserved name by index, where 0 <= index <

.

IsReservedName(ConstStringParam name) const

Returns true if the field name is reserved.

Updates |*out_location| to the source location of the complete extent of this enum declaration.

The number of values for this EnumDescriptor.

Guaranteed to be greater than zero.

Gets a value by index, where 0 <= index < value_count().

These are returned in the order they were defined in the .proto file.

Looks up a value by number.

Returns nullptr if no such value exists. If multiple values have this number, the first one defined is returned.

If this enum type is nested in a message type, this is that message type.

Otherwise, nullptr.

Get options for this enum type.

These are specified in the .proto file by placing lines like "option foo = 1234;" in the enum definition. Allowed options are defined by EnumOptions in descriptor.proto, and any available extensions of that message.

Returns true if this is a placeholder for an unknown enum.

This will only be the case if this descriptor comes from a DescriptorPool with AllowUnknownDependencies() set.

Gets an reserved range by index, where 0 <= index < reserved_range_count().

These are returned in the order they were defined in the .proto file.

Gets a reserved name by index, where 0 <= index < reserved_name_count().

Can't use PROTOBUF_DEFINE_ARRAY_ACCESSOR because reserved_names_ is actually an array of pointers rather than the usual array of objects.

Updates |*out_location| to the source location of the complete extent of this enum declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

A range of reserved field numbers.

start

inclusive

end

inclusive

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes an individual enum constant of a particular type.

To get the EnumValueDescriptor for a given enum value, first get the EnumDescriptor for its type, then use EnumDescriptor::FindValueByName() or EnumDescriptor::FindValueByNumber(). Use DescriptorPool to construct your own descriptors.

EnumValueDescriptorProto Proto

name() const

Name of this enum constant.

index() const

Index within the enums's

.

number() const

Numeric value of this enum constant.

full_name() const

The full_name of an enum value is a sibling symbol of the enum type.

file() const

The .proto file in which this value was defined. Never nullptr.

type() const

The type of this value. Never nullptr.

options() const

Get options for this enum value.

CopyTo(EnumValueDescriptorProto * proto) const

See

.

DebugString() const

See

.

See

.

Updates |*out_location| to the source location of the complete extent of this enum value declaration.

The full_name of an enum value is a sibling symbol of the enum type.

e.g. the full name of FieldDescriptorProto::TYPE_INT32 is actually "google.protobuf.FieldDescriptorProto.TYPE_INT32", NOT "google.protobuf.FieldDescriptorProto.Type.TYPE_INT32". This is to conform with C++ scoping rules for enums.

Get options for this enum value.

These are specified in the .proto file by adding text like "[[]foo = 1234]" after an enum value definition. Allowed options are defined by EnumValueOptions in descriptor.proto, and any available extensions of that message.

Updates |*out_location| to the source location of the complete extent of this enum value declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes an RPC service.

Use DescriptorPool to construct your own descriptors.

ServiceDescriptorProto Proto

name() const

The name of the service, not including its containing scope.

full_name() const

The fully-qualified name of the service, scope delimited by periods.

index() const

Index of this service within the file's services array.

file() const

The .proto file in which this service was defined. Never nullptr.

options() const

Get options for this service type.

method_count() const

The number of methods this service defines.

method(int index) const

Gets a

by index, where 0 <= index <

.

FindMethodByName(ConstStringParam name) const

Look up a

by name.

CopyTo(ServiceDescriptorProto * proto) const

See

.

DebugString() const

See

.

See

.

Updates |*out_location| to the source location of the complete extent of this service declaration.

Get options for this service type.

These are specified in the .proto file by placing lines like "option foo = 1234;" in the service definition. Allowed options are defined by ServiceOptions in descriptor.proto, and any available extensions of that message.

Updates |*out_location| to the source location of the complete extent of this service declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes an individual service method.

To obtain a MethodDescriptor given a service, first get its ServiceDescriptor, then call ServiceDescriptor::FindMethodByName(). Use DescriptorPool to construct your own descriptors.

MethodDescriptorProto Proto

name() const

Name of this method, not including containing scope.

full_name() const

The fully-qualified name of the method, scope delimited by periods.

index() const

Index within the service's

.

file() const

The .proto file in which this method was defined. Never nullptr.

service() const

Gets the service to which this method belongs. Never nullptr.

input_type() const

Gets the type of protocol message which this method accepts as input.

output_type() const

Gets the type of protocol message which this message produces as output.

client_streaming() const

Gets whether the client streams multiple requests.

server_streaming() const

Gets whether the server streams multiple responses.

options() const

Get options for this method.

CopyTo(MethodDescriptorProto * proto) const

See

.

DebugString() const

See

.

See

.

Updates |*out_location| to the source location of the complete extent of this method declaration.

Get options for this method.

These are specified in the .proto file by placing lines like "option foo = 1234;" in curly-braces after a method declaration. Allowed options are defined by MethodOptions in descriptor.proto, and any available extensions of that message.

Updates |*out_location| to the source location of the complete extent of this method declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Describes a whole .proto file.

To get the FileDescriptor for a compiled-in file, get the descriptor for something defined in that file and call descriptor->file(). Use DescriptorPool to construct your own descriptors.

Syntax

Syntax of this file.

FileDescriptorProto Proto

name() const

The filename, relative to the source tree.

package() const

The package, e.g. "google.protobuf.compiler".

pool() const

The

in which this

and all its contents were allocated.

dependency_count() const

The number of files imported by this one.

dependency(int index) const

Gets an imported file by index, where 0 <= index <

.

public_dependency_count() const

The number of files public imported by this one.

public_dependency(int index) const

Gets a public imported file by index, where 0 <= index <

.

weak_dependency_count() const

The number of files that are imported for weak fields.

weak_dependency(int index) const

Gets a weak imported file by index, where 0 <= index <

.

message_type_count() const

Number of top-level message types defined in this file.

message_type(int index) const

Gets a top-level message type, where 0 <= index <

.

enum_type_count() const

Number of top-level enum types defined in this file.

enum_type(int index) const

Gets a top-level enum type, where 0 <= index <

.

service_count() const

Number of services defined in this file.

service(int index) const

Gets a service, where 0 <= index <

.

extension_count() const

Number of extensions defined at file scope.

extension(int index) const

Gets an extension's descriptor, where 0 <= index <

.

options() const

Get options for this file.

syntax() const

FindMessageTypeByName(ConstStringParam name) const

Find a top-level message type by name (not full_name).

FindEnumTypeByName(ConstStringParam name) const

Find a top-level enum type by name. Returns nullptr if not found.

FindEnumValueByName(ConstStringParam name) const

Find an enum value defined in any top-level enum by name.

FindServiceByName(ConstStringParam name) const

Find a service definition by name. Returns nullptr if not found.

FindExtensionByName(ConstStringParam name) const

Find a top-level extension definition by name.

FindExtensionByLowercaseName(ConstStringParam name) const

Similar to

, but searches by lowercased-name.

FindExtensionByCamelcaseName(ConstStringParam name) const

Similar to

, but searches by camelcased-name.

CopyTo(FileDescriptorProto * proto) const

See

.

CopySourceCodeInfoTo(FileDescriptorProto * proto) const

Write the source code information of this

into the given FileDescriptorProto.

CopyJsonNameTo(FileDescriptorProto * proto) const

Fill the json_name field of FieldDescriptorProto for all fields.

DebugString() const

See

.

See

.

is_placeholder() const

Returns true if this is a placeholder for an unknown file.

Updates |*out_location| to the source location of the complete extent of this file declaration (namely, the empty path).

Updates |*out_location| to the source location of the complete extent of the declaration or declaration-part denoted by |path|.

Syntax of this file.

The filename, relative to the source tree.

e.g. "foo/bar/baz.proto"

Gets an imported file by index, where 0 <= index < dependency_count().

These are returned in the order they were defined in the .proto file.

The number of files public imported by this one.

The public dependency list is a subset of the dependency list.

Gets a public imported file by index, where 0 <= index < public_dependency_count().

These are returned in the order they were defined in the .proto file.

The number of files that are imported for weak fields.

The weak dependency list is a subset of the dependency list.

Gets a weak imported file by index, where 0 <= index < weak_dependency_count().

These are returned in the order they were defined in the .proto file.

Number of top-level message types defined in this file.

(This does not include nested types.)

Gets a top-level message type, where 0 <= index < message_type_count().

These are returned in the order they were defined in the .proto file.

Number of top-level enum types defined in this file.

(This does not include nested types.)

Gets a top-level enum type, where 0 <= index < enum_type_count().

These are returned in the order they were defined in the .proto file.

Gets a service, where 0 <= index < service_count().

These are returned in the order they were defined in the .proto file.

Number of extensions defined at file scope.

(This does not include extensions nested within message types.)

Gets an extension's descriptor, where 0 <= index < extension_count().

These are returned in the order they were defined in the .proto file.

Get options for this file.

These are specified in the .proto file by placing lines like "option foo = 1234;" at the top level, outside of any other definitions. Allowed options are defined by FileOptions in descriptor.proto, and any available extensions of that message.

Find a top-level message type by name (not full_name).

Returns nullptr if not found.

Find an enum value defined in any top-level enum by name.

Returns nullptr if not found.

Find a top-level extension definition by name.

Returns nullptr if not found.

Write the source code information of this FileDescriptor into the given FileDescriptorProto.

See CopyTo() above.

Fill the json_name field of FieldDescriptorProto for all fields.

Can only be called after CopyTo().

Returns true if this is a placeholder for an unknown file.

This will only be the case if this descriptor comes from a DescriptorPool with AllowUnknownDependencies() set.

Updates |*out_location| to the source location of the complete extent of the declaration or declaration-part denoted by |path|.

Returns false and leaves |*out_location| unchanged iff location information was not available. (See SourceCodeInfo for description of path encoding.)

#include <google/protobuf/descriptor.h>
namespace google::protobuf

Used to construct descriptors.

Normally you won't want to build your own descriptors. Message classes constructed by the protocol compiler will provide them for you. However, if you are implementing Message on your own, or if you are writing a program which can operate on totally arbitrary types and needs to load them from some sort of database, you might need to.

Since Descriptors are composed of a whole lot of cross-linked bits of data that would be a pain to put together manually, the DescriptorPool class is provided to make the process easier. It can take a FileDescriptorProto (defined in descriptor.proto), validate it, and convert it to a set of nicely cross-linked Descriptors.

DescriptorPool also helps with memory management. Descriptors are composed of many objects containing static data and pointers to each other. In all likelihood, when it comes time to delete this data, you'll want to delete it all at once. In fact, it is not uncommon to have a whole pool of descriptors all cross-linked with each other which you wish to delete all at once. This class represents such a pool, and handles the memory management for you.

You can also search for descriptors within a DescriptorPool by name, and extensions by number.

DescriptorPool()

Create a normal, empty

.

~DescriptorPool()

FindFileByName(ConstStringParam name) const

Find a

in the pool by file name.

FindFileContainingSymbol(ConstStringParam symbol_name) const

Find the

in the pool which defines the given symbol.

generated_pool()

Get a pointer to the generated pool.

These find descriptors by fully-qualified name. These will find both top-level descriptors and nested descriptors. They return nullptr if not found.

FindMessageTypeByName(ConstStringParam name) const

FindFieldByName(ConstStringParam name) const

FindExtensionByName(ConstStringParam name) const

FindOneofByName(ConstStringParam name) const

FindEnumTypeByName(ConstStringParam name) const

FindEnumValueByName(ConstStringParam name) const

FindServiceByName(ConstStringParam name) const

FindMethodByName(ConstStringParam name) const

Finds an extension of the given type by number.

Finds an extension of the given type by its printable name.

Finds extensions of extendee.

BuildFile(const FileDescriptorProto & proto)

Convert the FileDescriptorProto to real descriptors and place them in this

.

Same as

except errors are sent to the given

.

AllowUnknownDependencies()

By default, it is an error if a FileDescriptorProto contains references to types or other files that are not found in the

(or its backing

, if any).

EnforceWeakDependencies(bool enforce)

By default, weak imports are allowed to be missing, in which case we will use a placeholder for the dependency and convert the field to be an Empty message field.

These methods MUST NOT be called from outside the proto2 library.

These methods may contain hidden pitfalls and may be removed in a future library version.

Create a

which is overlaid on top of some other pool.

DisallowEnforceUtf8()

Disallow [[]enforce_utf8 = false] in .proto files.

InternalDontEnforceDependencies()

For internal use only: Changes the behavior of

such that it allows the file to make reference to message types declared in other files which it did not officially declare as dependencies.

InternalSetLazilyBuildDependencies()

For internal use only: Enables lazy building of dependencies of a file.

For internal use only.

InternalIsFileLoaded(ConstStringParam filename) const

For internal (unit test) use only: Returns true if a

has been constructed for the given file, false otherwise.

AddUnusedImportTrackFile(ConstStringParam file_name, bool is_error = false)

Add a file to unused_import_track_files_.

ClearUnusedImportTrackFiles()

InternalAddGeneratedFile(const void * encoded_file_descriptor, int size)

Called by generated classes at init time to add their descriptors to generated_pool.

internal_generated_pool()

For internal use only: Gets a non-const pointer to the generated pool.

internal_generated_database()

For internal use only: Gets a non-const pointer to the generated descriptor database.

Find a FileDescriptor in the pool by file name.

Returns nullptr if not found.

Find the FileDescriptor in the pool which defines the given symbol.

If any of the Find*ByName() methods below would succeed, then this is equivalent to calling that method and calling the result's file() method. Otherwise this returns nullptr.

Get a pointer to the generated pool.

Generated protocol message classes which are compiled into the binary will allocate their descriptors in this pool. Do not add your own descriptors to this pool.

Finds an extension of the given type by number.

The extendee must be a member of this DescriptorPool or one of its underlays.

Finds an extension of the given type by its printable name.

See comments above PrintableNameForExtension() for the definition of "printable name". The extendee must be a member of this DescriptorPool or one of its underlays. Returns nullptr if there is no known message extension with the given printable name.

Finds extensions of extendee.

The extensions will be appended to out in an undefined order. Only extensions defined directly in this DescriptorPool or one of its underlays are guaranteed to be found: extensions defined in the fallback database might not be found depending on the database implementation.

Convert the FileDescriptorProto to real descriptors and place them in this DescriptorPool.

All dependencies of the file must already be in the pool. Returns the resulting FileDescriptor, or nullptr if there were problems with the input (e.g. the message was invalid, or dependencies were missing). Details about the errors are written to GOOGLE_LOG(ERROR).

By default, it is an error if a FileDescriptorProto contains references to types or other files that are not found in the DescriptorPool (or its backing DescriptorDatabase, if any).

If you call AllowUnknownDependencies(), however, then unknown types and files will be replaced by placeholder descriptors (which can be identified by the is_placeholder() method). This can allow you to perform some useful operations with a .proto file even if you do not have access to other .proto files on which it depends. However, some heuristics must be used to fill in the gaps in information, and these can lead to descriptors which are inaccurate. For example, the DescriptorPool may be forced to guess whether an unknown type is a message or an enum, as well as what package it resides in. Furthermore, placeholder types will not be discoverable via FindMessageTypeByName() and similar methods, which could confuse some descriptor-based algorithms. Generally, the results of this option should be handled with extreme care.

By default, weak imports are allowed to be missing, in which case we will use a placeholder for the dependency and convert the field to be an Empty message field.

If you call EnforceWeakDependencies(true), however, the DescriptorPool will report a import not found error.

Create a DescriptorPool which is overlaid on top of some other pool.

If you search for a descriptor in the overlay and it is not found, the underlay will be searched as a backup. If the underlay has its own underlay, that will be searched next, and so on. This also means that files built in the overlay will be cross-linked with the underlay's descriptors if necessary. The underlay remains property of the caller; it must remain valid for the lifetime of the newly-constructed pool.

Example: Say you want to parse a .proto file at runtime in order to use its type with a DynamicMessage. Say this .proto file has dependencies, but you know that all the dependencies will be things that are already compiled into the binary. For ease of use, you'd like to load the types right out of generated_pool() rather than have to parse redundant copies of all these .protos and runtime. But, you don't want to add the parsed types directly into generated_pool(): this is not allowed, and would be bad design anyway. So, instead, you could use generated_pool() as an underlay for a new DescriptorPool in which you add only the new file.

WARNING: Use of underlays can lead to many subtle gotchas. Instead, try to formulate what you want to do in terms of DescriptorDatabases.

For internal use only: Enables lazy building of dependencies of a file.

Delay the building of dependencies of a file descriptor until absolutely necessary, like when message_type() is called on a field that is defined in that dependency's file. This will cause functional issues if a proto or one of its dependencies has errors. Should only be enabled for the generated_pool_ (because no descriptor build errors are guaranteed by the compilation generation process), testing, or if a lack of descriptor build errors can be guaranteed for a pool.

For internal (unit test) use only: Returns true if a FileDescriptor has been constructed for the given file, false otherwise.

Useful for testing lazy descriptor initialization behavior.

Add a file to unused_import_track_files_.

DescriptorBuilder will log warnings or errors for those files if there is any unused import.

Called by generated classes at init time to add their descriptors to generated_pool.

Do NOT call this in your own code! filename must be a permanent string (e.g. a string literal).

For internal use only: Gets a non-const pointer to the generated pool.

This is called at static-initialization time only, so thread-safety is not a concern. If both an underlay and a fallback database are present, the underlay takes precedence.

For internal use only: Gets a non-const pointer to the generated descriptor database.

Only used for testing.

#include <google/protobuf/descriptor.h>
namespace google::protobuf

When converting a FileDescriptorProto to a FileDescriptor, various errors might be detected in the input.

The caller may handle these programmatically by implementing an ErrorCollector.

ErrorLocation

These constants specify what exact part of the construct is broken.

ErrorCollector()

~ErrorCollector()

Reports an error in the FileDescriptorProto.

Reports a warning in the FileDescriptorProto.

These constants specify what exact part of the construct is broken.

This is useful e.g. for mapping the error back to an exact location in a .proto file.

Reports an error in the FileDescriptorProto.

Use this function if the problem occurred should interrupt building the FileDescriptorProto.

Reports a warning in the FileDescriptorProto.

Use this function if the problem occurred should NOT interrupt building the FileDescriptorProto.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4