Struct prost_reflect::ExtensionDescriptor

pub struct ExtensionDescriptor { /* private fields */ }

A protobuf extension field definition.

Implementations

impl ExtensionDescriptor

pub fn parent_pool(&self) -> &DescriptorPool

Gets a reference to the DescriptorPool this extension field is defined in.

pub fn parent_file(&self) -> FileDescriptor

Gets the FileDescriptor this extension field is defined in.

pub fn parent_message(&self) -> Option<MessageDescriptor>

Gets the parent message type if this extension is defined within another message, or None otherwise.

Note this just corresponds to where the extension is defined in the proto file. See containing_message for the message this field extends.

pub fn name(&self) -> &str

Gets the short name of the extension field type, e.g. my_extension.

pub fn full_name(&self) -> &str

Gets the full name of the extension field, e.g. my.package.ParentMessage.my_extension.

Note this includes the name of the parent message if any, not the message this field extends.

pub fn package_name(&self) -> &str

Gets the name of the package this extension field is defined in, e.g. my.package.

If no package name is set, an empty string is returned.

pub fn path(&self) -> &[i32]

Gets the path where this extension field is defined within the FileDescriptorProto, e.g. [7, 0].

See path for more details on the structure of the path.

pub fn parent_file_descriptor_proto(&self) -> &FileDescriptorProto

Gets a reference to the FileDescriptorProto in which this extension is defined.

pub fn field_descriptor_proto(&self) -> &FieldDescriptorProto

Gets a reference to the raw FieldDescriptorProto wrapped by this ExtensionDescriptor.

pub fn options(&self) -> DynamicMessage

Decodes the options defined for this ExtensionDescriptor, including any extension options.

pub fn number(&self) -> u32

Gets the number for this extension field.

pub fn json_name(&self) -> &str

Gets the name used for JSON serialization of this extension field, e.g. [my.package.ParentMessage.my_field].

pub fn is_group(&self) -> bool

Whether this field is encoded using the proto2 group encoding.

pub fn is_list(&self) -> bool

Whether this field is a list type.

Equivalent to checking that the cardinality is Repeated and that is_map returns false.

pub fn is_map(&self) -> bool

Whether this field is a map type.

Equivalent to checking that the cardinality is Repeated and that the field type is a message where is_map_entry returns true.

pub fn is_packed(&self) -> bool

Whether this field is a list encoded using packed encoding.

pub fn cardinality(&self) -> Cardinality

The cardinality of this field.

pub fn supports_presence(&self) -> bool

Whether this extension supports distinguishing between an unpopulated field and the default value.

This is equivalent to cardinality() != Cardinality::Repeated

pub fn kind(&self) -> Kind

Gets the Kind of this field.

pub fn containing_message(&self) -> MessageDescriptor

Gets the containing message that this field extends.

Trait Implementations

impl Clone for ExtensionDescriptor

fn clone(&self) -> ExtensionDescriptor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExtensionDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ExtensionDescriptor

fn eq(&self, other: &ExtensionDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ExtensionDescriptor

impl StructuralPartialEq for ExtensionDescriptor