Struct protobuf::descriptor::FieldDescriptorProto

pub struct FieldDescriptorProto {
    pub name: Option<String>,
    pub number: Option<i32>,
    pub label: Option<EnumOrUnknown<Label>>,
    pub type_: Option<EnumOrUnknown<Type>>,
    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: MessageField<FieldOptions>,
    pub proto3_optional: Option<bool>,
    pub special_fields: SpecialFields,
}

Describes a field within a message.

Fields

name: Option<String>

number: Option<i32>

label: Option<EnumOrUnknown<Label>>

type_: Option<EnumOrUnknown<Type>>

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: MessageField<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.

special_fields: SpecialFields

Implementations

impl FieldDescriptorProto

pub fn new() -> FieldDescriptorProto

pub fn name(&self) -> &str

pub fn clear_name(&mut self)

pub fn has_name(&self) -> bool

pub fn set_name(&mut self, v: String)

pub fn mut_name(&mut self) -> &mut String

pub fn take_name(&mut self) -> String

pub fn number(&self) -> i32

pub fn clear_number(&mut self)

pub fn has_number(&self) -> bool

pub fn set_number(&mut self, v: i32)

pub fn label(&self) -> Label

pub fn clear_label(&mut self)

pub fn has_label(&self) -> bool

pub fn set_label(&mut self, v: Label)

pub fn type_(&self) -> Type

pub fn clear_type_(&mut self)

pub fn has_type(&self) -> bool

pub fn set_type(&mut self, v: Type)

pub fn type_name(&self) -> &str

pub fn clear_type_name(&mut self)

pub fn has_type_name(&self) -> bool

pub fn set_type_name(&mut self, v: String)

pub fn mut_type_name(&mut self) -> &mut String

pub fn take_type_name(&mut self) -> String

pub fn extendee(&self) -> &str

pub fn clear_extendee(&mut self)

pub fn has_extendee(&self) -> bool

pub fn set_extendee(&mut self, v: String)

pub fn mut_extendee(&mut self) -> &mut String

pub fn take_extendee(&mut self) -> String

pub fn default_value(&self) -> &str

pub fn clear_default_value(&mut self)

pub fn has_default_value(&self) -> bool

pub fn set_default_value(&mut self, v: String)

pub fn mut_default_value(&mut self) -> &mut String

pub fn take_default_value(&mut self) -> String

pub fn oneof_index(&self) -> i32

pub fn clear_oneof_index(&mut self)

pub fn has_oneof_index(&self) -> bool

pub fn set_oneof_index(&mut self, v: i32)

pub fn json_name(&self) -> &str

pub fn clear_json_name(&mut self)

pub fn has_json_name(&self) -> bool

pub fn set_json_name(&mut self, v: String)

pub fn mut_json_name(&mut self) -> &mut String

pub fn take_json_name(&mut self) -> String

pub fn proto3_optional(&self) -> bool

pub fn clear_proto3_optional(&mut self)

pub fn has_proto3_optional(&self) -> bool

pub fn set_proto3_optional(&mut self, v: bool)

Trait Implementations

impl Clone for FieldDescriptorProto

fn clone(&self) -> FieldDescriptorProto

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FieldDescriptorProto

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

Formats the value using the given formatter.

impl<'a> Default for &'a FieldDescriptorProto

fn default() -> &'a FieldDescriptorProto

Returns the “default value” for a type.

impl Default for FieldDescriptorProto

fn default() -> FieldDescriptorProto

Returns the “default value” for a type.

impl Display for FieldDescriptorProto

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

Formats the value using the given formatter.

impl Message for FieldDescriptorProto

const NAME: &'static str = "FieldDescriptorProto"

Message name as specified in .proto file.

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<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

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

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> FieldDescriptorProto

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static FieldDescriptorProto

Return a pointer to default immutable message with static lifetime.

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

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

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

Write the message to the stream.

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.

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.

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

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>

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

fn parse_from_bytes(bytes: &[u8]) -> Result<Self>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>

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

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

Check if all required fields of this object are initialized.

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

Write the message to the writer.

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

Write the message to bytes vec.

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

Write the message to bytes vec.

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.

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.

fn 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.

impl MessageFull for FieldDescriptorProto

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq for FieldDescriptorProto

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProtobufValue for FieldDescriptorProto

type RuntimeType = RuntimeTypeMessage<FieldDescriptorProto>

Actual implementation of type properties.

impl StructuralPartialEq for FieldDescriptorProto