Struct 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 option_dependency: Vec<String>,
    pub message_type: Vec<DescriptorProto>,
    pub enum_type: Vec<EnumDescriptorProto>,
    pub service: Vec<ServiceDescriptorProto>,
    pub extension: Vec<FieldDescriptorProto>,
    pub options: Option<FileOptions>,
    pub source_code_info: Option<SourceCodeInfo>,
    pub syntax: Option<String>,
    pub edition: Option<i32>,
}

Describes a complete .proto file.

Fields

name: Option<String>

file name, relative to root of source tree

package: Option<String>

e.g. “foo”, “foo.bar”, etc.

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.

option_dependency: Vec<String>

Names of files imported by this file purely for the purpose of providing option extensions. These are excluded from the dependency list above.

message_type: Vec<DescriptorProto>

All top-level definitions in this file.

enum_type: Vec<EnumDescriptorProto>

service: Vec<ServiceDescriptorProto>

extension: Vec<FieldDescriptorProto>

options: Option<FileOptions>

source_code_info: Option<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”, “proto3”, and “editions”.

If edition is present, this value must be “editions”. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

edition: Option<i32>

The edition of the proto file. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

Implementations

impl FileDescriptorProto

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn package(&self) -> &str

Returns the value of package, or the default value if package is unset.

pub fn syntax(&self) -> &str

Returns the value of syntax, or the default value if syntax is unset.

pub fn edition(&self) -> Edition

Returns the enum value of edition, or the default if the field is unset or set to an invalid enum value.

pub fn set_edition(&mut self, value: Edition)

Sets edition to the provided enum value.

Trait Implementations

impl Clone for FileDescriptorProto

fn clone(&self) -> FileDescriptorProto

Returns a duplicate of the value.

const 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() -> Self

Returns the “default value” for a type.

impl Message for FileDescriptorProto

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FileDescriptorProto

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for FileDescriptorProto