Struct protobuf::descriptor::FileDescriptorProto
source · [−]pub struct FileDescriptorProto {Show 13 fields
pub name: Option<String>,
pub package: Option<String>,
pub dependency: Vec<String>,
pub public_dependency: Vec<i32>,
pub weak_dependency: Vec<i32>,
pub message_type: Vec<DescriptorProto>,
pub enum_type: Vec<EnumDescriptorProto>,
pub service: Vec<ServiceDescriptorProto>,
pub extension: Vec<FieldDescriptorProto>,
pub options: MessageField<FileOptions>,
pub source_code_info: MessageField<SourceCodeInfo>,
pub syntax: Option<String>,
pub special_fields: SpecialFields,
}
Expand description
Describes a complete .proto file.
Fields
name: Option<String>
package: Option<String>
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.
message_type: Vec<DescriptorProto>
All top-level definitions in this file.
enum_type: Vec<EnumDescriptorProto>
service: Vec<ServiceDescriptorProto>
extension: Vec<FieldDescriptorProto>
options: MessageField<FileOptions>
source_code_info: MessageField<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” and “proto3”.
special_fields: SpecialFields
Implementations
sourceimpl FileDescriptorProto
impl FileDescriptorProto
pub fn new() -> FileDescriptorProto
pub fn name(&self) -> &str
pub fn clear_name(&mut self)
pub fn has_name(&self) -> bool
pub fn set_name(&mut self, v: String)
pub fn mut_name(&mut self) -> &mut String
pub fn take_name(&mut self) -> String
pub fn package(&self) -> &str
pub fn clear_package(&mut self)
pub fn has_package(&self) -> bool
pub fn set_package(&mut self, v: String)
pub fn mut_package(&mut self) -> &mut String
pub fn take_package(&mut self) -> String
pub fn syntax(&self) -> &str
pub fn clear_syntax(&mut self)
pub fn has_syntax(&self) -> bool
pub fn set_syntax(&mut self, v: String)
pub fn mut_syntax(&mut self) -> &mut String
pub fn take_syntax(&mut self) -> String
Trait Implementations
sourceimpl Clone for FileDescriptorProto
impl Clone for FileDescriptorProto
sourcefn clone(&self) -> FileDescriptorProto
fn clone(&self) -> FileDescriptorProto
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for FileDescriptorProto
impl Debug for FileDescriptorProto
sourceimpl Default for FileDescriptorProto
impl Default for FileDescriptorProto
sourcefn default() -> FileDescriptorProto
fn default() -> FileDescriptorProto
Returns the “default value” for a type. Read more
sourceimpl<'a> Default for &'a FileDescriptorProto
impl<'a> Default for &'a FileDescriptorProto
sourcefn default() -> &'a FileDescriptorProto
fn default() -> &'a FileDescriptorProto
Returns the “default value” for a type. Read more
sourceimpl Display for FileDescriptorProto
impl Display for FileDescriptorProto
sourceimpl Message for FileDescriptorProto
impl Message for FileDescriptorProto
sourceconst NAME: &'static str = "FileDescriptorProto"
const NAME: &'static str = "FileDescriptorProto"
Message name as specified in .proto
file. Read more
sourcefn is_initialized(&self) -> bool
fn is_initialized(&self) -> bool
True iff all required fields are initialized.
Always returns true
for protobuf 3. Read more
sourcefn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
Update this message object with fields read from given stream.
sourcefn compute_size(&self) -> u64
fn compute_size(&self) -> u64
Compute and cache size of this message and all nested messages. Read more
sourcefn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
fn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
Write message to the stream. Read more
sourcefn special_fields(&self) -> &SpecialFields
fn special_fields(&self) -> &SpecialFields
Special fields (unknown fields and cached size).
sourcefn mut_special_fields(&mut self) -> &mut SpecialFields
fn mut_special_fields(&mut self) -> &mut SpecialFields
Special fields (unknown fields and cached size).
sourcefn new() -> FileDescriptorProto
fn new() -> FileDescriptorProto
Create an empty message object. Read more
sourcefn default_instance() -> &'static FileDescriptorProto
fn default_instance() -> &'static FileDescriptorProto
Return a pointer to default immutable message with static lifetime. Read more
sourcefn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>
fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>
Parse message from stream.
sourcefn cached_size(&self) -> u32
fn cached_size(&self) -> u32
Get size previously computed by compute_size
. Read more
sourcefn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
Write the message to the stream. Read more
sourcefn write_length_delimited_to(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
fn write_length_delimited_to(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
Write the message to the stream prepending the message with message length encoded as varint. Read more
sourcefn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>
fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>
Write the message to the vec, prepend the message with message length encoded as varint. Read more
sourcefn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>
fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>
Update this message object with fields read from given stream.
sourcefn parse_from_reader(reader: &mut dyn Read) -> Result<Self>
fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>
Parse message from reader. Parse stops on EOF or when error encountered. Read more
sourcefn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>
fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>
Parse message from Bytes
object.
Resulting message may share references to the passed bytes object. Read more
sourcefn check_initialized(&self) -> Result<()>
fn check_initialized(&self) -> Result<()>
Check if all required fields of this object are initialized.
sourcefn write_to_writer(&self, w: &mut dyn Write) -> Result<()>
fn write_to_writer(&self, w: &mut dyn Write) -> Result<()>
Write the message to the writer.
sourcefn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()>
fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()>
Write the message to the writer, prepend the message with message length encoded as varint. Read more
sourcefn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>>
fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>>
Write the message to the bytes vec, prepend the message with message length encoded as varint. Read more
sourcefn unknown_fields(&self) -> &UnknownFields
fn unknown_fields(&self) -> &UnknownFields
Get a reference to unknown fields.
sourcefn mut_unknown_fields(&mut self) -> &mut UnknownFields
fn mut_unknown_fields(&mut self) -> &mut UnknownFields
Get a mutable reference to unknown fields.
sourceimpl MessageFull for FileDescriptorProto
impl MessageFull for FileDescriptorProto
sourcefn descriptor() -> MessageDescriptor
fn descriptor() -> MessageDescriptor
Get message descriptor for message type. Read more
sourcefn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool
fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool
Reflective equality. Read more
sourceimpl PartialEq<FileDescriptorProto> for FileDescriptorProto
impl PartialEq<FileDescriptorProto> for FileDescriptorProto
sourcefn eq(&self, other: &FileDescriptorProto) -> bool
fn eq(&self, other: &FileDescriptorProto) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &FileDescriptorProto) -> bool
fn ne(&self, other: &FileDescriptorProto) -> bool
This method tests for !=
.
sourceimpl ProtobufValue for FileDescriptorProto
impl ProtobufValue for FileDescriptorProto
type RuntimeType = RuntimeTypeMessage<FileDescriptorProto>
type RuntimeType = RuntimeTypeMessage<FileDescriptorProto>
Actual implementation of type properties.
sourcefn runtime_type_box() -> RuntimeTypeBox
fn runtime_type_box() -> RuntimeTypeBox
Dynamic version of the type.
sourcefn as_ref(value: &Self) -> ReflectValueRef<'_>
fn as_ref(value: &Self) -> ReflectValueRef<'_>
Pointer to a dynamic reference.
sourcefn as_mut(value: &mut Self) -> ReflectValueMut<'_>
fn as_mut(value: &mut Self) -> ReflectValueMut<'_>
Mutable pointer to a dynamic mutable reference.
sourcefn from_value_box(value_box: ReflectValueBox) -> Result<Self, ReflectValueBox>
fn from_value_box(value_box: ReflectValueBox) -> Result<Self, ReflectValueBox>
Construct a value from given reflective value. Read more
sourcefn set_from_value_box(target: &mut Self, value_box: ReflectValueBox)
fn set_from_value_box(target: &mut Self, value_box: ReflectValueBox)
Write the value.
sourcefn default_value_ref() -> ReflectValueRef<'static>
fn default_value_ref() -> ReflectValueRef<'static>
Default value for this type.
sourcefn into_static_value_ref(value: Self) -> ReflectValueRef<'static>
fn into_static_value_ref(value: Self) -> ReflectValueRef<'static>
Convert a value into a ref value if possible. Read more
sourcefn is_non_zero(value: &Self) -> bool
fn is_non_zero(value: &Self) -> bool
Value is non-default?
impl StructuralPartialEq for FileDescriptorProto
Auto Trait Implementations
impl RefUnwindSafe for FileDescriptorProto
impl Send for FileDescriptorProto
impl Sync for FileDescriptorProto
impl Unpin for FileDescriptorProto
impl UnwindSafe for FileDescriptorProto
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more