Struct prost_reflect::EnumDescriptor

source ·
pub struct EnumDescriptor { /* private fields */ }
Expand description

A protobuf enum type.

Implementations§

source§

impl EnumDescriptor

source

pub fn parent_pool(&self) -> &DescriptorPool

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

source

pub fn parent_file(&self) -> FileDescriptor

Gets the FileDescriptor this enum type is defined in.

source

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

source

pub fn name(&self) -> &str

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

source

pub fn full_name(&self) -> &str

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

source

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.

source

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.

source

pub fn parent_file_descriptor_proto(&self) -> &FileDescriptorProto

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

source

pub fn enum_descriptor_proto(&self) -> &EnumDescriptorProto

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

source

pub fn options(&self) -> DynamicMessage

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

source

pub fn default_value(&self) -> EnumValueDescriptor

Gets the default value for the enum type.

source

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.

source

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.

source

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

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

source

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

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

source

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

Gets an iterator over reserved value names in this enum.

Trait Implementations§

source§

impl Clone for EnumDescriptor

source§

fn clone(&self) -> EnumDescriptor

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for EnumDescriptor

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for EnumDescriptor

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Eq for EnumDescriptor

source§

impl StructuralPartialEq for EnumDescriptor

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.