Struct protobuf::plugin::CodeGeneratorRequest
source · [−]pub struct CodeGeneratorRequest {
pub file_to_generate: Vec<String>,
pub parameter: Option<String>,
pub proto_file: Vec<FileDescriptorProto>,
pub compiler_version: MessageField<Version>,
pub special_fields: SpecialFields,
}
Expand description
An encoded CodeGeneratorRequest is written to the plugin’s stdin.
Fields
file_to_generate: Vec<String>
The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file’s descriptor will be included in proto_file, below.
parameter: Option<String>
The generator parameter passed on the command-line.
proto_file: Vec<FileDescriptorProto>
FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it.
protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc’s end – it will store all fields in memory at once before sending them to the plugin.
Type names of fields and extensions in the FileDescriptorProto are always fully qualified.
compiler_version: MessageField<Version>
The version number of protocol compiler.
special_fields: SpecialFields
Implementations
sourceimpl CodeGeneratorRequest
impl CodeGeneratorRequest
pub fn new() -> CodeGeneratorRequest
pub fn parameter(&self) -> &str
pub fn clear_parameter(&mut self)
pub fn has_parameter(&self) -> bool
pub fn set_parameter(&mut self, v: String)
pub fn mut_parameter(&mut self) -> &mut String
pub fn take_parameter(&mut self) -> String
Trait Implementations
sourceimpl Clone for CodeGeneratorRequest
impl Clone for CodeGeneratorRequest
sourcefn clone(&self) -> CodeGeneratorRequest
fn clone(&self) -> CodeGeneratorRequest
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for CodeGeneratorRequest
impl Debug for CodeGeneratorRequest
sourceimpl<'a> Default for &'a CodeGeneratorRequest
impl<'a> Default for &'a CodeGeneratorRequest
sourcefn default() -> &'a CodeGeneratorRequest
fn default() -> &'a CodeGeneratorRequest
sourceimpl Default for CodeGeneratorRequest
impl Default for CodeGeneratorRequest
sourcefn default() -> CodeGeneratorRequest
fn default() -> CodeGeneratorRequest
sourceimpl Display for CodeGeneratorRequest
impl Display for CodeGeneratorRequest
sourceimpl Message for CodeGeneratorRequest
impl Message for CodeGeneratorRequest
sourceconst NAME: &'static str = "CodeGeneratorRequest"
const NAME: &'static str = "CodeGeneratorRequest"
.proto
file. Read moresourcefn is_initialized(&self) -> bool
fn is_initialized(&self) -> bool
true
for protobuf 3. Read moresourcefn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>
sourcefn compute_size(&self) -> u64
fn compute_size(&self) -> u64
sourcefn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
fn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<()>
sourcefn special_fields(&self) -> &SpecialFields
fn special_fields(&self) -> &SpecialFields
sourcefn mut_special_fields(&mut self) -> &mut SpecialFields
fn mut_special_fields(&mut self) -> &mut SpecialFields
sourcefn new() -> CodeGeneratorRequest
fn new() -> CodeGeneratorRequest
sourcefn default_instance() -> &'static CodeGeneratorRequest
fn default_instance() -> &'static CodeGeneratorRequest
sourcefn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>
fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>
sourcefn cached_size(&self) -> u32
fn cached_size(&self) -> u32
compute_size
. Read moresourcefn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
sourcefn write_length_delimited_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
fn write_length_delimited_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>
sourcefn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>
fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>
sourcefn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>
fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>
sourcefn parse_from_reader(reader: &mut dyn Read) -> Result<Self>
fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>
sourcefn parse_from_bytes(bytes: &[u8]) -> Result<Self>
fn parse_from_bytes(bytes: &[u8]) -> Result<Self>
sourcefn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>
fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>
Bytes
object.
Resulting message may share references to the passed bytes object. Read more