Struct protobuf::reflect::FieldDescriptor

pub struct FieldDescriptor { /* fields omitted */ }

Field descriptor.

Can be used for runtime reflection.

Implementations

impl FieldDescriptor

pub fn get_proto(&self) -> &FieldDescriptorProto

Get .proto description of field

pub fn get_name(&self) -> &str

Field name as specified in .proto file

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

Oneof descriptor containing this field.

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_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) -> RuntimeTypeBox

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 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<FieldDescriptor> for FieldDescriptor

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

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

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

This method tests for !=.

impl Eq for FieldDescriptor

impl StructuralEq for FieldDescriptor

impl StructuralPartialEq for FieldDescriptor