Struct prost_types::Field

pub struct Field {
    pub kind: i32,
    pub cardinality: i32,
    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

kind: i32

The field type.

cardinality: i32

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.

Methods

impl Field

pub fn kind(&self) -> Kind

Returns the enum value of kind, or the default if the field is set to an invalid enum value.

pub fn set_kind(&mut self, value: Kind)

Sets kind to the provided enum value.

pub fn cardinality(&self) -> Cardinality

Returns the enum value of cardinality, or the default if the field is set to an invalid enum value.

pub fn set_cardinality(&mut self, value: Cardinality)

Sets cardinality to the provided enum value.

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 Message for Field

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Field> for Field

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

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

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

This method tests for !=.

impl StructuralPartialEq for Field