Struct protobuf::descriptor::FileDescriptorProto

pub struct FileDescriptorProto {

    pub name: Option<String>,
    pub package: Option<String>,
    pub dependency: Vec<String>,
    pub public_dependency: Vec<i32>,
    pub weak_dependency: Vec<i32>,
    pub message_type: Vec<DescriptorProto>,
    pub enum_type: Vec<EnumDescriptorProto>,
    pub service: Vec<ServiceDescriptorProto>,
    pub extension: Vec<FieldDescriptorProto>,
    pub options: MessageField<FileOptions>,
    pub source_code_info: MessageField<SourceCodeInfo>,
    pub syntax: Option<String>,
    pub special_fields: SpecialFields,
}

Describes a complete .proto file.

Fields

name: Option<String>

package: Option<String>

dependency: Vec<String>

Names of files imported by this file.

public_dependency: Vec<i32>

Indexes of the public imported files in the dependency list above.

weak_dependency: Vec<i32>

Indexes of the weak imported files in the dependency list. For Google-internal migration only. Do not use.

message_type: Vec<DescriptorProto>

All top-level definitions in this file.

enum_type: Vec<EnumDescriptorProto>

service: Vec<ServiceDescriptorProto>

extension: Vec<FieldDescriptorProto>

options: MessageField<FileOptions>

source_code_info: MessageField<SourceCodeInfo>

This field contains optional information about the original source code. You may safely remove this entire field without harming runtime functionality of the descriptors – the information is needed only by development tools.

syntax: Option<String>

The syntax of the proto file. The supported values are “proto2” and “proto3”.

special_fields: SpecialFields

Implementations

impl FileDescriptorProto

pub fn new() -> FileDescriptorProto

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 package(&self) -> &str

pub fn clear_package(&mut self)

pub fn has_package(&self) -> bool

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

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

pub fn take_package(&mut self) -> String

pub fn syntax(&self) -> &str

pub fn clear_syntax(&mut self)

pub fn has_syntax(&self) -> bool

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

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

pub fn take_syntax(&mut self) -> String

Trait Implementations

impl Clone for FileDescriptorProto

fn clone(&self) -> FileDescriptorProto

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDescriptorProto

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

Formats the value using the given formatter.

impl Default for FileDescriptorProto

fn default() -> FileDescriptorProto

Returns the “default value” for a type.

impl<'a> Default for &'a FileDescriptorProto

fn default() -> &'a FileDescriptorProto

Returns the “default value” for a type.

impl Display for FileDescriptorProto

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

Formats the value using the given formatter.

impl Message for FileDescriptorProto

const NAME: &'static str = "FileDescriptorProto"

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() -> FileDescriptorProto

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static FileDescriptorProto

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 FileDescriptorProto

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq<FileDescriptorProto> for FileDescriptorProto

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

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

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

This method tests for !=.

impl ProtobufValue for FileDescriptorProto

type RuntimeType = RuntimeTypeMessage<FileDescriptorProto>

Actual implementation of type properties.

impl StructuralPartialEq for FileDescriptorProto