Struct FileDescriptor

pub struct FileDescriptor { /* private fields */ }

A single source file containing protobuf messages and services.

Implementations

impl FileDescriptor

pub fn new(descriptor_pool: DescriptorPool, index: usize) -> Self

Create a new FileDescriptor referencing the file at index within the given DescriptorPool.

Panics

Panics if index is out-of-bounds.

pub fn parent_pool(&self) -> &DescriptorPool

Gets a reference to the DescriptorPool this file is included in.

pub fn name(&self) -> &str

Gets the unique name of this file relative to the root of the source tree, e.g. path/to/my_package.proto.

pub fn package_name(&self) -> &str

Gets the name of the package specifier for a file, e.g. my.package.

If no package name is set, an empty string is returned.

pub fn index(&self) -> usize

Gets the index of this file within the parent DescriptorPool.

pub fn syntax(&self) -> Syntax

Gets the syntax of this protobuf file.

pub fn dependencies(&self) -> impl ExactSizeIterator<Item = FileDescriptor> + '_

Gets the dependencies of this file.

This corresponds to the FileDescriptorProto::dependency field.

pub fn public_dependencies( &self, ) -> impl ExactSizeIterator<Item = FileDescriptor> + '_

Gets the public dependencies of this file.

This corresponds to the FileDescriptorProto::public_dependency field.

pub fn messages(&self) -> impl ExactSizeIterator<Item = MessageDescriptor> + '_

Gets the top-level message types defined within this file.

This does not include nested messages defined within another message.

pub fn enums(&self) -> impl ExactSizeIterator<Item = EnumDescriptor> + '_

Gets the top-level enum types defined within this file.

This does not include nested enums defined within another message.

pub fn extensions( &self, ) -> impl ExactSizeIterator<Item = ExtensionDescriptor> + '_

Gets the top-level extension fields defined within this file.

This does not include nested extensions defined within another message.

pub fn services(&self) -> impl ExactSizeIterator<Item = ServiceDescriptor> + '_

Gets the services defined within this file.

pub fn file_descriptor_proto(&self) -> &FileDescriptorProto

Gets a reference to the raw FileDescriptorProto wrapped by this FileDescriptor.

pub fn encode<B>(&self, buf: B) -> Result<(), EncodeError>

where B: BufMut,

Encodes this file descriptor to its byte representation.

The encoded message is equivalent to a FileDescriptorProto, however also includes any extension options that were defined.

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

Encodes this file descriptor to a newly allocated buffer.

The encoded message is equivalent to a FileDescriptorProto, however also includes any extension options that were defined.

pub fn options(&self) -> DynamicMessage

Decodes the options defined for this FileDescriptor, including any extension options.

Trait Implementations

impl Clone for FileDescriptor

fn clone(&self) -> FileDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDescriptor

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

Formats the value using the given formatter.

impl PartialEq for FileDescriptor

fn eq(&self, other: &FileDescriptor) -> 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 Eq for FileDescriptor

impl StructuralPartialEq for FileDescriptor