Struct prost_types::FieldDescriptorProto
source · pub struct FieldDescriptorProto {
pub name: Option<String>,
pub number: Option<i32>,
pub label: Option<i32>,
pub type: Option<i32>,
pub type_name: Option<String>,
pub extendee: Option<String>,
pub default_value: Option<String>,
pub oneof_index: Option<i32>,
pub json_name: Option<String>,
pub options: Option<FieldOptions>,
pub proto3_optional: Option<bool>,
}
Expand description
Describes a field within a message.
Fields§
§name: Option<String>
§number: Option<i32>
§label: Option<i32>
§type: Option<i32>
If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
type_name: Option<String>
For message and enum types, this is the name of the type. If the name starts with a ‘.’, it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
extendee: Option<String>
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
default_value: Option<String>
For numeric types, contains the original text representation of the value. For booleans, “true” or “false”. For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
oneof_index: Option<i32>
If set, gives the index of a oneof in the containing type’s oneof_decl list. This field is a member of that oneof.
json_name: Option<String>
JSON name of this field. The value is set by protocol compiler. If the user has set a “json_name” option on this field, that option’s value will be used. Otherwise, it’s deduced from the field’s name by converting it to camelCase.
options: Option<FieldOptions>
§proto3_optional: Option<bool>
If true, this is a proto3 “optional”. When a proto3 field is optional, it tracks presence regardless of field type.
When proto3_optional is true, this field must be belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a “synthetic” oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all “real” oneofs.
For message fields, proto3_optional doesn’t create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote “optional” or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can’t tell if a field is a message or an enum, so it must always create a synthetic oneof.
Proto2 optional fields do not set this flag, because they already indicate
optional with LABEL_OPTIONAL
.
Implementations§
source§impl FieldDescriptorProto
impl FieldDescriptorProto
sourcepub fn extendee(&self) -> &str
pub fn extendee(&self) -> &str
Returns the value of extendee
, or the default value if extendee
is unset.
sourcepub fn number(&self) -> i32
pub fn number(&self) -> i32
Returns the value of number
, or the default value if number
is unset.
sourcepub fn label(&self) -> Label
pub fn label(&self) -> Label
Returns the enum value of label
, or the default if the field is unset or set to an invalid enum value.
sourcepub fn type(&self) -> Type
pub fn type(&self) -> Type
Returns the enum value of type
, or the default if the field is unset or set to an invalid enum value.
sourcepub fn type_name(&self) -> &str
pub fn type_name(&self) -> &str
Returns the value of type_name
, or the default value if type_name
is unset.
sourcepub fn default_value(&self) -> &str
pub fn default_value(&self) -> &str
Returns the value of default_value
, or the default value if default_value
is unset.
sourcepub fn oneof_index(&self) -> i32
pub fn oneof_index(&self) -> i32
Returns the value of oneof_index
, or the default value if oneof_index
is unset.
sourcepub fn json_name(&self) -> &str
pub fn json_name(&self) -> &str
Returns the value of json_name
, or the default value if json_name
is unset.
sourcepub fn proto3_optional(&self) -> bool
pub fn proto3_optional(&self) -> bool
Returns the value of proto3_optional
, or the default value if proto3_optional
is unset.
Trait Implementations§
source§impl Clone for FieldDescriptorProto
impl Clone for FieldDescriptorProto
source§fn clone(&self) -> FieldDescriptorProto
fn clone(&self) -> FieldDescriptorProto
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for FieldDescriptorProto
impl Debug for FieldDescriptorProto
source§impl Default for FieldDescriptorProto
impl Default for FieldDescriptorProto
source§impl Message for FieldDescriptorProto
impl Message for FieldDescriptorProto
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,
source§fn encode_to_vec(&self) -> Vec<u8, Global>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,
self
.source§impl PartialEq<FieldDescriptorProto> for FieldDescriptorProto
impl PartialEq<FieldDescriptorProto> for FieldDescriptorProto
source§fn eq(&self, other: &FieldDescriptorProto) -> bool
fn eq(&self, other: &FieldDescriptorProto) -> bool
self
and other
values to be equal, and is used
by ==
.