Struct protobuf::plugin::CodeGeneratorRequest

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,
}

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

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

impl Clone for CodeGeneratorRequest

fn clone(&self) -> CodeGeneratorRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeGeneratorRequest

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

Formats the value using the given formatter.

impl Default for CodeGeneratorRequest

fn default() -> CodeGeneratorRequest

Returns the “default value” for a type.

impl<'a> Default for &'a CodeGeneratorRequest

fn default() -> &'a CodeGeneratorRequest

Returns the “default value” for a type.

impl Display for CodeGeneratorRequest

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

Formats the value using the given formatter.

impl Message for CodeGeneratorRequest

const NAME: &'static str = "CodeGeneratorRequest"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes(
    &self,
    os: &mut CodedOutputStream<'_>
) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> CodeGeneratorRequest

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static CodeGeneratorRequest

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>

Write the message to the stream.

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.

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.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

fn check_initialized(&self) -> Result<()>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<()>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<()>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>>

Write the message to bytes vec.

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.

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.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for CodeGeneratorRequest

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq<CodeGeneratorRequest> for CodeGeneratorRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl ProtobufValue for CodeGeneratorRequest

type RuntimeType = RuntimeTypeMessage<CodeGeneratorRequest>

Actual implementation of type properties.

impl StructuralPartialEq for CodeGeneratorRequest