Struct CodeGeneratorResponse

pub struct CodeGeneratorResponse {
    pub error: Option<String>,
    pub supported_features: Option<u64>,
    pub file: Vec<File>,
    pub special_fields: SpecialFields,
}

The plugin writes an encoded CodeGeneratorResponse to stdout.

Fields

error: Option<String>

Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way.

This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself – such as the input CodeGeneratorRequest being unparseable – should be reported by writing a message to stderr and exiting with a non-zero status code.

supported_features: Option<u64>

A bitmask of supported features that the code generator supports. This is a bitwise “or” of values from the Feature enum.

file: Vec<File>

special_fields: SpecialFields

Implementations

impl CodeGeneratorResponse

pub fn new() -> CodeGeneratorResponse

pub fn error(&self) -> &str

pub fn clear_error(&mut self)

pub fn has_error(&self) -> bool

pub fn set_error(&mut self, v: String)

pub fn mut_error(&mut self) -> &mut String

pub fn take_error(&mut self) -> String

pub fn supported_features(&self) -> u64

pub fn clear_supported_features(&mut self)

pub fn has_supported_features(&self) -> bool

pub fn set_supported_features(&mut self, v: u64)

Trait Implementations

impl Clone for CodeGeneratorResponse

fn clone(&self) -> CodeGeneratorResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeGeneratorResponse

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

Formats the value using the given formatter.

impl<'a> Default for &'a CodeGeneratorResponse

fn default() -> &'a CodeGeneratorResponse

Returns the “default value” for a type.

impl Default for CodeGeneratorResponse

fn default() -> CodeGeneratorResponse

Returns the “default value” for a type.

impl Display for CodeGeneratorResponse

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

Formats the value using the given formatter.

impl Message for CodeGeneratorResponse

const NAME: &'static str = "CodeGeneratorResponse"

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() -> CodeGeneratorResponse

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static CodeGeneratorResponse

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 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 CodeGeneratorResponse

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq for CodeGeneratorResponse

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProtobufValue for CodeGeneratorResponse

type RuntimeType = RuntimeTypeMessage<CodeGeneratorResponse>

Actual implementation of type properties.

impl StructuralPartialEq for CodeGeneratorResponse