Struct protobuf::plugin::code_generator_response::File

pub struct File {
    pub name: Option<String>,
    pub insertion_point: Option<String>,
    pub content: Option<String>,
    pub generated_code_info: MessageField<GeneratedCodeInfo>,
    pub special_fields: SpecialFields,
}

Represents a single generated file.

Fields

name: Option<String>

The file name, relative to the output directory. The name must not contain “.” or “..” components and must be relative, not be absolute (so, the file cannot lie outside the output directory). “/” must be used as the path separator, not “".

If the name is omitted, the content will be appended to the previous file. This allows the generator to break large files into small chunks, and allows the generated text to be streamed back to protoc so that large files need not reside completely in memory at one time. Note that as of this writing protoc does not optimize for this – it will read the entire CodeGeneratorResponse before writing files to disk.

insertion_point: Option<String>

If non-empty, indicates that the named file should already exist, and the content here is to be inserted into that file at a defined insertion point. This feature allows a code generator to extend the output produced by another code generator. The original generator may provide insertion points by placing special annotations in the file that look like: @@protoc_insertion_point(NAME) The annotation can have arbitrary text before and after it on the line, which allows it to be placed in a comment. NAME should be replaced with an identifier naming the point – this is what other generators will use as the insertion_point. Code inserted at this point will be placed immediately above the line containing the insertion point (thus multiple insertions to the same point will come out in the order they were added). The double-@ is intended to make it unlikely that the generated code could contain things that look like insertion points by accident.

For example, the C++ code generator places the following line in the .pb.h files that it generates: // @@protoc_insertion_point(namespace_scope) This line appears within the scope of the file’s package namespace, but outside of any particular class. Another plugin can then specify the insertion_point “namespace_scope” to generate additional classes or other declarations that should be placed in this scope.

Note that if the line containing the insertion point begins with whitespace, the same whitespace will be added to every line of the inserted text. This is useful for languages like Python, where indentation matters. In these languages, the insertion point comment should be indented the same amount as any inserted code will need to be in order to work correctly in that context.

The code generator that generates the initial file and the one which inserts into it must both run as part of a single invocation of protoc. Code generators are executed in the order in which they appear on the command line.

If |insertion_point| is present, |name| must also be present.

content: Option<String>

The file contents.

generated_code_info: MessageField<GeneratedCodeInfo>

Information describing the file content being inserted. If an insertion point is used, this information will be appropriately offset and inserted into the code generation metadata for the generated files.

special_fields: SpecialFields

Implementations

impl File

pub fn new() -> File

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 insertion_point(&self) -> &str

pub fn clear_insertion_point(&mut self)

pub fn has_insertion_point(&self) -> bool

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

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

pub fn take_insertion_point(&mut self) -> String

pub fn content(&self) -> &str

pub fn clear_content(&mut self)

pub fn has_content(&self) -> bool

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

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

pub fn take_content(&mut self) -> String

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl<'a> Default for &'a File

fn default() -> &'a File

Returns the “default value” for a type.

impl Default for File

fn default() -> File

Returns the “default value” for a type.

impl Display for File

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

Formats the value using the given formatter.

impl Message for File

const NAME: &'static str = "File"

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

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static File

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 File

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq<File> for File

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

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

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

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

impl ProtobufValue for File

type RuntimeType = RuntimeTypeMessage<File>

Actual implementation of type properties.

impl StructuralPartialEq for File