Struct prost_reflect::ExtensionDescriptor

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

A protobuf extension field definition.

Implementations§

source§

impl ExtensionDescriptor

source

pub fn parent_pool(&self) -> &DescriptorPool

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

source

pub fn parent_file(&self) -> FileDescriptor

Gets the FileDescriptor this extension field is defined in.

source

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.

source

pub fn name(&self) -> &str

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

source

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.

source

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.

source

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.

source

pub fn parent_file_descriptor_proto(&self) -> &FileDescriptorProto

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

source

pub fn field_descriptor_proto(&self) -> &FieldDescriptorProto

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

source

pub fn options(&self) -> DynamicMessage

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

source

pub fn number(&self) -> u32

Gets the number for this extension field.

source

pub fn json_name(&self) -> &str

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

source

pub fn is_group(&self) -> bool

Whether this field is encoded using the proto2 group encoding.

source

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.

source

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.

source

pub fn is_packed(&self) -> bool

Whether this field is a list encoded using packed encoding.

source

pub fn cardinality(&self) -> Cardinality

The cardinality of this field.

source

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

source

pub fn kind(&self) -> Kind

Gets the Kind of this field.

source

pub fn containing_message(&self) -> MessageDescriptor

Gets the containing message that this field extends.

Trait Implementations§

source§

impl Clone for ExtensionDescriptor

source§

fn clone(&self) -> ExtensionDescriptor

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 ExtensionDescriptor

source§

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

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

impl PartialEq for ExtensionDescriptor

source§

fn eq(&self, other: &ExtensionDescriptor) -> 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 ExtensionDescriptor

source§

impl StructuralPartialEq for ExtensionDescriptor

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.