Struct prost_reflect::FileDescriptor

pub struct FileDescriptor { /* private fields */ }

A wrapper around a FileDescriptorSet, which provides convenient APIs for the protobuf message definitions.

This type is immutable once constructed, and uses reference counting internally so it is cheap to clone.

Implementations

impl FileDescriptor

pub fn new(
    file_descriptor_set: FileDescriptorSet
) -> Result<Self, DescriptorError>

Create a FileDescriptor from a FileDescriptorSet.

A file descriptor set may be generated by running the protobuf compiler with the --descriptor_set_out flag. If you are using prost-build, then Config::file_descriptor_set_path is a convenient way to generated it as part of your build.

This method may return an error if file_descriptor_set is invalid, for example it contains references to types not in the set. If file_descriptor_set was created by the protobuf compiler, these error cases should never occur since it performs its own validation.

pub fn decode<B>(bytes: B) -> Result<Self, DescriptorError> where
    B: Buf, 

Decodes a FileDescriptorSet from its protobuf byte representation and creates a new FileDescriptor wrapping it.

pub fn file_descriptor_set(&self) -> &FileDescriptorSet

Gets a reference to the FileDescriptorSet wrapped by this FileDescriptor.

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

Gets an iterator over the services defined in these protobuf files.

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

Gets an iterator over all messages defined in these protobuf files.

The iterator includes nested messages defined in another message.

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

Gets an iterator over all enums defined in these protobuf files.

The iterator includes nested enums defined in another message.

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

Gets an iterator over all extension fields defined in these protobuf files.

The iterator includes nested extension fields defined in another message.

pub fn get_message_by_name(&self, name: &str) -> Option<MessageDescriptor>

Gets a MessageDescriptor by its fully qualified name, for example my.package.MessageName.

pub fn get_enum_by_name(&self, name: &str) -> Option<EnumDescriptor>

Gets an EnumDescriptor by its fully qualified name, for example my.package.EnumName.

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<FileDescriptor> for FileDescriptor

fn eq(&self, other: &Self) -> 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 !=.

impl Eq for FileDescriptor