Skip to main content

FieldDescriptor

Struct FieldDescriptor 

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

Handle to one field in a MessageDescriptor.

Implementations§

Source§

impl FieldDescriptor

Source

pub fn name(&self) -> &str

Proto field name.

Source

pub fn full_name(&self) -> &str

<message.full_name>.<name>, no leading dot.

Source

pub fn json_name(&self) -> &str

JSON field name (lower-camelCase by default; honors a user-supplied json_name option when present).

Source

pub fn number(&self) -> u32

Tag number on the wire.

Source

pub fn kind(&self) -> Kind

Resolved field Kind.

Source

pub fn cardinality(&self) -> Cardinality

Optional, Required, or Repeated.

Source

pub fn supports_presence(&self) -> bool

True iff the wire format tracks presence for this field (proto2 scalars, message-typed fields, oneof members, proto3 optional).

Source

pub fn is_packed(&self) -> bool

True iff the field uses packed encoding for repeated scalars.

Source

pub fn is_packable(&self) -> bool

True iff this field’s Kind admits packed encoding (scalar or enum) — independent of whether is_packed() is currently set.

Source

pub fn is_list(&self) -> bool

True iff this is a repeated (non-map) field.

Note that map<K, V> fields are technically also repeated on the wire, but their value model is crate::Value::Map, not crate::Value::List — this helper returns false for maps.

Source

pub fn parsed_default_value(&self) -> Option<Value>

Available on crate feature dynamic only.

Pre-parsed [default = ...] value, if the field carried one.

Available for any scalar / enum / string / bytes field whose proto declared an explicit default. None for proto3 fields, for repeated fields, and for fields without an explicit default.

Source

pub fn is_map(&self) -> bool

True iff this field models a map<K, V>.

A field is a map iff its kind is a message that carries the map_entry = true option.

Source

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

Containing oneof, when this field is part of one.

Source

pub fn parent_message(&self) -> MessageDescriptor

Owning message.

Source

pub fn descriptor_proto(&self) -> &FieldDescriptorProto

Raw FieldDescriptorProto for advanced use.

Trait Implementations§

Source§

impl Clone for FieldDescriptor

Source§

fn clone(&self) -> FieldDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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 Eq for FieldDescriptor

Source§

impl PartialEq for FieldDescriptor

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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,

Source§

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>,

Source§

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>,

Source§

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.