Struct Field

#[non_exhaustive]
pub struct Field {
    pub kind: Kind,
    pub cardinality: Cardinality,
    pub number: i32,
    pub name: String,
    pub type_url: String,
    pub oneof_index: i32,
    pub packed: bool,
    pub options: Vec<Option>,
    pub json_name: String,
    pub default_value: String,
}

A single field of a message type.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: Kind

The field type.

cardinality: Cardinality

The field cardinality.

number: i32

The field number.

name: String

The field name.

type_url: String

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

oneof_index: i32

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

packed: bool

Whether to use alternative packed wire representation.

options: Vec<Option>

The protocol buffer options.

json_name: String

The field JSON name.

default_value: String

The string value of the default value of this field. Proto2 syntax only.

Implementations

impl Field

pub fn set_kind<T: Into<Kind>>(self, v: T) -> Self

Sets the value of kind.

pub fn set_cardinality<T: Into<Cardinality>>(self, v: T) -> Self

Sets the value of cardinality.

pub fn set_number<T: Into<i32>>(self, v: T) -> Self

Sets the value of number.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_type_url<T: Into<String>>(self, v: T) -> Self

Sets the value of type_url.

pub fn set_oneof_index<T: Into<i32>>(self, v: T) -> Self

Sets the value of oneof_index.

pub fn set_packed<T: Into<bool>>(self, v: T) -> Self

Sets the value of packed.

pub fn set_json_name<T: Into<String>>(self, v: T) -> Self

Sets the value of json_name.

pub fn set_default_value<T: Into<String>>(self, v: T) -> Self

Sets the value of default_value.

pub fn set_options<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Option>,

Sets the value of options.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Field

where Field: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Field

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Field

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Field