pub struct FieldDescriptor { /* private fields */ }
Expand description

A protobuf message definition.

Implementations§

source§

impl FieldDescriptor

source

pub fn parent_pool(&self) -> &DescriptorPool

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

source

pub fn parent_file(&self) -> FileDescriptor

Gets the FileDescriptor this field is defined in.

source

pub fn parent_message(&self) -> &MessageDescriptor

Gets a reference to the MessageDescriptor this field is defined in.

source

pub fn name(&self) -> &str

Gets the short name of the message type, e.g. my_field.

source

pub fn full_name(&self) -> &str

Gets the full name of the message field, e.g. my.package.MyMessage.my_field.

source

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

Gets the path where this message field is defined within the FileDescriptorProto, e.g. [4, 0, 2, 0].

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

source

pub fn field_descriptor_proto(&self) -> &FieldDescriptorProto

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

source

pub fn options(&self) -> DynamicMessage

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

source

pub fn number(&self) -> u32

Gets the unique number for this message field.

source

pub fn json_name(&self) -> &str

Gets the name used for JSON serialization.

This is usually the camel-cased form of the field name, unless another value is set in the proto file.

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 field supports distinguishing between an unpopulated field and the default value.

For proto2 messages this returns true for all non-repeated fields. For proto3 this returns true for message fields, and fields contained in a oneof.

source

pub fn kind(&self) -> Kind

Gets the Kind of this field.

source

pub fn containing_oneof(&self) -> Option<OneofDescriptor>

Gets a OneofDescriptor representing the oneof containing this field, or None if this field is not contained in a oneof.

Trait Implementations§

source§

impl Clone for FieldDescriptor

source§

fn clone(&self) -> FieldDescriptor

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 FieldDescriptor

source§

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

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

impl PartialEq<FieldDescriptor> for FieldDescriptor

source§

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

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

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.
source§

impl Eq for FieldDescriptor

source§

impl StructuralEq for FieldDescriptor

source§

impl StructuralPartialEq for FieldDescriptor

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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.