Struct prost_types::FieldDescriptorProto
[−]
[src]
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>, }
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>
Methods
impl FieldDescriptorProto
[src]
fn name(&self) -> &str
[src]
fn extendee(&self) -> &str
[src]
fn number(&self) -> i32
[src]
fn label(&self) -> Label
[src]
fn set_label(&mut self, value: Label)
[src]
fn type_(&self) -> Type
[src]
fn set_type_(&mut self, value: Type)
[src]
fn type_name(&self) -> &str
[src]
fn default_value(&self) -> &str
[src]
fn oneof_index(&self) -> i32
[src]
fn json_name(&self) -> &str
[src]
Trait Implementations
impl Message for FieldDescriptorProto
[src]
fn encode_raw<B>(&self, buf: &mut B) where
B: BufMut,
[src]
B: BufMut,
fn merge_field<B>(&mut self, buf: &mut B) -> Result<(), DecodeError> where
B: Buf,
[src]
B: Buf,
fn encoded_len(&self) -> usize
[src]
Returns the encoded length of the message without a length delimiter.
fn clear(&mut self)
[src]
Clears the message, resetting all fields to their default.
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
[src]
B: BufMut,
Encodes the message to a buffer. Read more
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
[src]
B: BufMut,
Encodes the message with a length-delimiter to a buffer. Read more
fn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: IntoBuf,
Self: Default,
[src]
B: IntoBuf,
Self: Default,
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: IntoBuf,
Self: Default,
[src]
B: IntoBuf,
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: IntoBuf,
[src]
B: IntoBuf,
Decodes an instance of the message from a buffer, and merges it into self
. Read more
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: IntoBuf,
[src]
B: IntoBuf,
Decodes a length-delimited instance of the message from buffer, and merges it into self
. Read more
impl Default for FieldDescriptorProto
[src]
fn default() -> FieldDescriptorProto
[src]
Returns the "default value" for a type. Read more
impl Debug for FieldDescriptorProto
[src]
impl Clone for FieldDescriptorProto
[src]
fn clone(&self) -> FieldDescriptorProto
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq for FieldDescriptorProto
[src]
fn eq(&self, __arg_0: &FieldDescriptorProto) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &FieldDescriptorProto) -> bool
[src]
This method tests for !=
.