Skip to main content

FileDescriptor

Struct FileDescriptor 

Source
pub struct FileDescriptor { /* private fields */ }
Expand description

Reflection for objects defined in .proto file (messages, enums, etc).

The object is refcounted: clone is shallow.

The equality performs pointer comparison: two clones of the same FileDescriptor objects are equal, but two FileDescriptor objects created from the same FileDescriptorProto objects are not equal.

Implementations§

Source§

impl FileDescriptor

Source

pub fn name(&self) -> &str

The file name.

Source

pub fn package(&self) -> &str

Protobuf package.

Source

pub fn syntax(&self) -> Syntax

Syntax of current file.

Source

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

Top-level messages.

Source

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

Get top-level enums.

Source

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

Get services defined in .proto file.

Source

pub fn extensions(&self) -> impl Iterator<Item = FieldDescriptor> + '_

Extension fields.

Source

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

Find message by name relative to the package.

Only search in the current file, not in any dependencies.

Source

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

Find message by name relative to the package.

Only search in the current file, not in any dependencies.

Source

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

Find message by fully-qualified name.

Only search in the current file, not in any dependencies.

Source

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

Find enum by name fully-qualified name.

Only search in the current file, not in any dependencies.

Source

pub fn new_dynamic( proto: FileDescriptorProto, dependencies: &[FileDescriptor], ) -> Result<FileDescriptor>

Dynamic message created from FileDescriptorProto without generated files.

Source

pub fn new_dynamic_fds( protos: Vec<FileDescriptorProto>, dependencies: &[FileDescriptor], ) -> Result<Vec<FileDescriptor>>

Create a set of file descriptors from individual file descriptors.

Source

pub fn proto(&self) -> &FileDescriptorProto

.proto data for this file.

Source

pub fn deps(&self) -> &[FileDescriptor]

Direct dependencies of this file.

Source

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

Subset of dependencies which are public

Trait Implementations§

Source§

impl Clone for FileDescriptor

Source§

fn clone(&self) -> FileDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for FileDescriptor

Source§

impl Hash for FileDescriptor

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FileDescriptor

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FileDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.