Struct prost_reflect::EnumDescriptor

pub struct EnumDescriptor { /* private fields */ }

A protobuf enum type.

Implementations

impl EnumDescriptor

pub fn parent_pool(&self) -> &DescriptorPool

Gets a reference to the DescriptorPool this enum type is defined in.

pub fn parent_file(&self) -> FileDescriptor

Gets the FileDescriptor this enum type is defined in.

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

Gets the parent message type if this enum type is nested inside a another message, or None otherwise

pub fn name(&self) -> &str

Gets the short name of the enum type, e.g. MyEnum.

pub fn full_name(&self) -> &str

Gets the full name of the enum, e.g. my.package.MyEnum.

pub fn package_name(&self) -> &str

Gets the name of the package this enum type 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 enum type is defined within the FileDescriptorProto, e.g. [5, 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 enum is defined.

pub fn enum_descriptor_proto(&self) -> &EnumDescriptorProto

Gets a reference to the raw EnumDescriptorProto wrapped by this EnumDescriptor.

pub fn options(&self) -> DynamicMessage

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

pub fn default_value(&self) -> EnumValueDescriptor

Gets the default value for the enum type.

pub fn get_value_by_name(&self, name: &str) -> Option<EnumValueDescriptor>

Gets a EnumValueDescriptor for the enum value with the given name, or None if no such value exists.

pub fn get_value(&self, number: i32) -> Option<EnumValueDescriptor>

Gets a EnumValueDescriptor for the enum value with the given number, or None if no such value exists.

If the enum is defined with the allow_alias option and has multiple values with the given number, it is unspecified which one will be returned.

pub fn values(&self) -> impl ExactSizeIterator<Item = EnumValueDescriptor> + '_

Gets an iterator yielding a EnumValueDescriptor for each value in this enum.

pub fn reserved_ranges( &self ) -> impl ExactSizeIterator<Item = RangeInclusive<i32>> + '_

Gets an iterator over reserved value number ranges in this enum.

pub fn reserved_names(&self) -> impl ExactSizeIterator<Item = &str> + '_

Gets an iterator over reserved value names in this enum.

Trait Implementations

impl Clone for EnumDescriptor

fn clone(&self) -> EnumDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnumDescriptor

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

Formats the value using the given formatter.

impl PartialEq for EnumDescriptor

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for EnumDescriptor

impl StructuralPartialEq for EnumDescriptor