Struct FieldDescriptor

pub struct FieldDescriptor { /* private fields */ }

Field descriptor.

Can be used for runtime reflection.

Implementations

impl FieldDescriptor

pub fn proto(&self) -> &FieldDescriptorProto

Get .proto description of field

pub fn name(&self) -> &str

Field name as specified in .proto file.

pub fn number(&self) -> i32

Field number as specified in .proto file.

pub fn full_name(&self) -> String

Fully qualified name of the field: fully qualified name of the declaring type followed by the field name.

Declaring type is a message (for regular field or extensions) or a package (for top-level extensions).

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

Oneof descriptor containing this field. Do not skip synthetic oneofs.

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

Oneof containing this field.

Return None if this field is not part of oneof or if it is synthetic oneof.

pub fn containing_message(&self) -> MessageDescriptor

Message which contains this field.

For extension fields, this is the message being extended.

pub fn json_name(&self) -> &str

JSON field name.

Can be different from .proto field name.

See JSON mapping for details.

pub fn is_singular(&self) -> bool

If this field is optional or required.

pub fn is_required(&self) -> bool

Is this field required.

pub fn is_repeated_or_map(&self) -> bool

If this field repeated or map?

pub fn is_repeated(&self) -> bool

Is this field repeated, but not map field?

pub fn is_map(&self) -> bool

If this field a map field?

pub fn has_field(&self, m: &dyn MessageDyn) -> bool

Check if field is set in given message.

For repeated field or map field return true if collection is not empty.

Panics

If this field belongs to a different message type.

pub fn get_message<'a>(&self, m: &'a dyn MessageDyn) -> MessageRef<'a>

Get message field or default instance if field is unset.

Panics

If this field belongs to a different message type or field type is not message.

pub fn mut_message<'a>( &self, m: &'a mut dyn MessageDyn, ) -> &'a mut dyn MessageDyn

Get a mutable reference to a message field. Initialize field with default message if unset.

Panics

If this field belongs to a different message type or field type is not singular message.

pub fn singular_default_value(&self) -> ReflectValueRef<'_>

Default value.

Panics

If field is not singular.

pub fn get_singular_field_or_default<'a>( &self, m: &'a dyn MessageDyn, ) -> ReflectValueRef<'a>

Get singular field value.

Return field default value if field is unset.

Panics

If this field belongs to a different message type or fields is not singular.

pub fn singular_runtime_type(&self) -> RuntimeType

Runtime representation of singular field.

Panics

If this field belongs to a different message type or field is not singular.

pub fn set_singular_field(&self, m: &mut dyn MessageDyn, value: ReflectValueBox)

Set singular field.

Panics

If this field belongs to a different message type or field is not singular or value is of different type.

pub fn clear_field(&self, m: &mut dyn MessageDyn)

Clear a field.

pub fn runtime_field_type(&self) -> RuntimeFieldType

Dynamic representation of field type.

pub fn get_reflect<'a>(&self, m: &'a dyn MessageDyn) -> ReflectFieldRef<'a>

Get field of any type.

Panics

If this field belongs to a different message type.

pub fn get_singular<'a>( &self, m: &'a dyn MessageDyn, ) -> Option<ReflectValueRef<'a>>

Get singular field value.

Return None if field is unset.

Panics

If this field belongs to a different message type or fields is not singular.

pub fn get_repeated<'a>(&self, m: &'a dyn MessageDyn) -> ReflectRepeatedRef<'a>

Get repeated field.

Panics

If this field belongs to a different message type or field is not repeated.

pub fn mut_repeated<'a>( &self, m: &'a mut dyn MessageDyn, ) -> ReflectRepeatedMut<'a>

Get a mutable reference to repeated field.

Panics

If this field belongs to a different message type or field is not repeated.

pub fn get_map<'a>(&self, m: &'a dyn MessageDyn) -> ReflectMapRef<'a>

Get map field.

Panics

If this field belongs to a different message type or field is not map.

pub fn mut_map<'a>(&self, m: &'a mut dyn MessageDyn) -> ReflectMapMut<'a>

Get a mutable reference to map field.

Panics

If this field belongs to a different message type or field is not map.

Trait Implementations

impl Clone for FieldDescriptor

fn clone(&self) -> FieldDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for FieldDescriptor

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

Formats the value using the given formatter.

impl PartialEq for FieldDescriptor

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

impl StructuralPartialEq for FieldDescriptor