Struct protobuf::well_known_types::Field

pub struct Field {
    pub kind: ProtobufEnumOrUnknown<Kind>,
    pub cardinality: ProtobufEnumOrUnknown<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,
    pub unknown_fields: UnknownFields,
    pub cached_size: CachedSize,
}

A single field of a message type.

Fields

kind: ProtobufEnumOrUnknown<Kind>

The field type.

cardinality: ProtobufEnumOrUnknown<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.

unknown_fields: UnknownFields

cached_size: CachedSize

Implementations

impl Field

pub fn new() -> Field

Trait Implementations

impl Clear for Field

fn clear(&mut self)

Clear this make, make it equivalent to newly created object.

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<'a> Default for &'a Field

fn default() -> &'a Field

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Field

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

Formats the value using the given formatter.

impl Message for Field

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> ProtobufResult<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u32

Compute and cache size of this message and all nested messages

fn write_to_with_cached_sizes(
    &self,
    os: &mut CodedOutputStream<'_>
) -> ProtobufResult<()>

Write message to the stream.

fn get_cached_size(&self) -> u32

Get size previously computed by compute_size.

fn get_unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

fn new() -> Field

Create an empty message object.

fn descriptor_static() -> MessageDescriptor

Get message descriptor for message type.

fn default_instance() -> &'static Field

Return a pointer to default immutable message with static lifetime.

fn descriptor_by_instance(&self) -> MessageDescriptor

Message descriptor for this message, used for reflection.

fn parse_from(is: &mut CodedInputStream<'_>) -> ProtobufResult<Self>

Parse message from stream.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> ProtobufResult<()>

Write the message to the stream.

fn write_length_delimited_to(
    &self,
    os: &mut CodedOutputStream<'_>
) -> ProtobufResult<()>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> ProtobufResult<()>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> ProtobufResult<()>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> ProtobufResult<Self> where
    Self: Sized, 

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> ProtobufResult<Self> where
    Self: Sized, 

Parse message from byte array.

fn parse_from_carllerche_bytes(bytes: &Bytes) -> ProtobufResult<Self> where
    Self: Sized, 

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

fn check_initialized(&self) -> ProtobufResult<()>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> ProtobufResult<()>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> ProtobufResult<()>

Write the message to bytes vec.

fn write_to_bytes(&self) -> ProtobufResult<Vec<u8>>

Write the message to bytes vec.

fn write_length_delimited_to_writer(
    &self,
    w: &mut dyn Write
) -> ProtobufResult<()>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> ProtobufResult<Vec<u8>>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

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

type RuntimeType = RuntimeTypeMessage<Self>

Actual implementation of type properties.

fn runtime_type_box() -> RuntimeTypeBox

Dynamic version of the type.

fn as_ref(value: &Self) -> ReflectValueRef<'_>

Pointer to a dynamic reference.

fn as_mut(value: &mut Self) -> ReflectValueMut<'_>

Mutable pointer to a dynamic mutable reference.

fn from_value_box(value_box: ReflectValueBox) -> Result<Self, ReflectValueBox>

Construct a value from given reflective value.

fn set_from_value_box(target: &mut Self, value_box: ReflectValueBox)

Write the value.

fn default_value_ref() -> ReflectValueRef<'static>

Default value for this type.

fn into_static_value_ref(value: Self) -> ReflectValueRef<'static>

Convert a value into a ref value if possible.

fn is_non_zero(value: &Self) -> bool

Value is non-default?

fn cast_to_enum_values(values: &[Self]) -> &[i32]

Cast enum element data to integers.

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