Struct protobuf::well_known_types::type_::Field
source · pub struct Field {
pub kind: EnumOrUnknown<Kind>,
pub cardinality: EnumOrUnknown<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 special_fields: SpecialFields,
}
Expand description
A single field of a message type.
Fields§
§kind: EnumOrUnknown<Kind>
The field type.
cardinality: EnumOrUnknown<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.
special_fields: SpecialFields
Implementations§
Trait Implementations§
source§impl Message for Field
impl Message for Field
source§fn is_initialized(&self) -> bool
fn is_initialized(&self) -> bool
True iff all required fields are initialized.
Always returns
true
for protobuf 3.source§fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
Update this message object with fields read from given stream.
source§fn compute_size(&self) -> u64
fn compute_size(&self) -> u64
Compute and cache size of this message and all nested messages. Read more
source§fn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_> ) -> Result<()>
Write message to the stream. Read more
source§fn special_fields(&self) -> &SpecialFields
fn special_fields(&self) -> &SpecialFields
Special fields (unknown fields and cached size).
source§fn mut_special_fields(&mut self) -> &mut SpecialFields
fn mut_special_fields(&mut self) -> &mut SpecialFields
Special fields (unknown fields and cached size).
source§fn default_instance() -> &'static Field
fn default_instance() -> &'static Field
Return a pointer to default immutable message with static lifetime. Read more
source§fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>
fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>
Parse message from stream.
source§fn cached_size(&self) -> u32
fn cached_size(&self) -> u32
Get size previously computed by
compute_size
. Read moresource§fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
Write the message to the stream. Read more
source§fn write_length_delimited_to(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_> ) -> Result<()>
Write the message to the stream prepending the message with message length
encoded as varint.
source§fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>
fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>
Write the message to the vec, prepend the message with message length
encoded as varint.
source§fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>
fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>
Update this message object with fields read from given stream.
source§fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>
fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>
Parse message from reader.
Parse stops on EOF or when error encountered.
source§fn parse_from_bytes(bytes: &[u8]) -> Result<Self>
fn parse_from_bytes(bytes: &[u8]) -> Result<Self>
Parse message from byte array.
source§fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>
fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>
Parse message from
Bytes
object.
Resulting message may share references to the passed bytes object.source§fn check_initialized(&self) -> Result<()>
fn check_initialized(&self) -> Result<()>
Check if all required fields of this object are initialized.
source§fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()>
fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()>
Write the message to the writer, prepend the message with message length
encoded as varint.
source§fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>>
fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>>
Write the message to the bytes vec, prepend the message with message length
encoded as varint.
source§fn unknown_fields(&self) -> &UnknownFields
fn unknown_fields(&self) -> &UnknownFields
Get a reference to unknown fields.
source§fn mut_unknown_fields(&mut self) -> &mut UnknownFields
fn mut_unknown_fields(&mut self) -> &mut UnknownFields
Get a mutable reference to unknown fields.
source§impl MessageFull for Field
impl MessageFull for Field
source§fn descriptor() -> MessageDescriptor
fn descriptor() -> MessageDescriptor
Get message descriptor for message type. Read more
source§fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool
fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool
Reflective equality. Read more
source§impl PartialEq for Field
impl PartialEq for Field
source§impl ProtobufValue for Field
impl ProtobufValue for Field
§type RuntimeType = RuntimeTypeMessage<Field>
type RuntimeType = RuntimeTypeMessage<Field>
Actual implementation of type properties.
impl StructuralPartialEq for Field
Auto Trait Implementations§
impl RefUnwindSafe for Field
impl Send for Field
impl Sync for Field
impl Unpin for Field
impl UnwindSafe for Field
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<M> MessageDyn for Mwhere
M: MessageFull,
impl<M> MessageDyn for Mwhere
M: MessageFull,
source§fn descriptor_dyn(&self) -> MessageDescriptor
fn descriptor_dyn(&self) -> MessageDescriptor
Message descriptor for this message, used for reflection.
source§fn merge_from_dyn(&mut self, is: &mut CodedInputStream<'_>) -> Result<(), Error>
fn merge_from_dyn(&mut self, is: &mut CodedInputStream<'_>) -> Result<(), Error>
Update this message fields with contents of given stream.
source§fn write_to_with_cached_sizes_dyn(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<(), Error>
fn write_to_with_cached_sizes_dyn( &self, os: &mut CodedOutputStream<'_> ) -> Result<(), Error>
Write the message.
source§fn compute_size_dyn(&self) -> u64
fn compute_size_dyn(&self) -> u64
Compute (and cache) the message size.
source§fn is_initialized_dyn(&self) -> bool
fn is_initialized_dyn(&self) -> bool
True iff all required fields are initialized.
Always returns
true
for protobuf 3.source§fn special_fields_dyn(&self) -> &SpecialFields
fn special_fields_dyn(&self) -> &SpecialFields
Get a reference to special fields.
source§fn mut_special_fields_dyn(&mut self) -> &mut SpecialFields
fn mut_special_fields_dyn(&mut self) -> &mut SpecialFields
Get a mutable reference to special fields.