Struct DescriptorPool 

pub struct DescriptorPool { /* private fields */ }

A pool of protobuf descriptors built from one or more FileDescriptorSets.

Cloning is cheap (Arc-shared inner). All descriptor handles (MessageDescriptor, FieldDescriptor, EnumDescriptor, …) own a DescriptorPool and are themselves cheap to clone.

Implementations

impl DescriptorPool

pub fn new() -> Self

Construct an empty pool.

pub fn decode(bytes: &[u8]) -> Result<Self, DescriptorError>

Decode a serialized google.protobuf.FileDescriptorSet into a pool.

Errors

Returns DescriptorError::Decode if the bytes are not a valid FileDescriptorSet, or any of the validation errors documented on DescriptorError.

pub fn from_file_descriptor_set( fds: FileDescriptorSet, ) -> Result<Self, DescriptorError>

Build a pool from an already-decoded FileDescriptorSet.

Errors

See DescriptorError.

pub fn add_file_descriptor_set( &mut self, fds: FileDescriptorSet, ) -> Result<(), DescriptorError>

Merge another FileDescriptorSet into the pool.

Errors

See DescriptorError.

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

Iterate over every file in the pool.

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

Iterate over every message in the pool, including nested messages and synthesized map-entry messages.

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

Iterate over every enum in the pool, including nested enums.

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

Resolve a fully-qualified message name. Accepts either pkg.Name or .pkg.Name (the leading dot is stripped).

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

Resolve a fully-qualified enum name (with or without leading dot).

pub fn get_file_by_name(&self, name: &str) -> Option<FileDescriptor>

Resolve a file by its descriptor name (e.g. acme/api/v1/user.proto).

impl DescriptorPool

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

Iterate every service in the pool.

pub fn get_service_by_name(&self, full_name: &str) -> Option<ServiceDescriptor>

Resolve a fully-qualified service name (with or without leading dot).

Trait Implementations

impl Clone for DescriptorPool

fn clone(&self) -> DescriptorPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptorPool

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

Formats the value using the given formatter.

impl Default for DescriptorPool

fn default() -> DescriptorPool

Returns the “default value” for a type.