Struct puroro_codegen::File

pub struct File(_);

Represents a single generated file.

Implementations

impl File

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

pub fn clear_name(&mut self)

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

pub fn clear_insertion_point(&mut self)

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

pub fn clear_content(&mut self)

pub fn generated_code_info_mut(&mut self) -> &mut GeneratedCodeInfo

pub fn clear_generated_code_info(&mut self)

pub const NAME_FIELD_NUMBER: i32 = 1i32

pub const INSERTION_POINT_FIELD_NUMBER: i32 = 2i32

pub const CONTENT_FIELD_NUMBER: i32 = 15i32

pub const GENERATED_CODE_INFO_FIELD_NUMBER: i32 = 16i32

Methods from Deref<Target = FileView>

pub fn name(&self) -> &str

pub fn name_opt(&self) -> Option<&str>

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.

pub fn has_name(&self) -> bool

pub fn insertion_point(&self) -> &str

pub fn insertion_point_opt(&self) -> Option<&str>

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.

pub fn has_insertion_point(&self) -> bool

pub fn content(&self) -> &str

pub fn content_opt(&self) -> Option<&str>

The file contents.

pub fn has_content(&self) -> bool

pub fn generated_code_info(&self) -> Option<&GeneratedCodeInfoView>

pub fn generated_code_info_opt(&self) -> Option<&GeneratedCodeInfoView>

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.

pub fn has_generated_code_info(&self) -> bool

Trait Implementations

impl Borrow<FileView> for File

fn borrow(&self) -> &FileView

Immutably borrows from an owned value.

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, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for File

fn default() -> File

Returns the “default value” for a type.

impl Deref for File

type Target = FileView

The resulting type after dereferencing.

fn deref(&self) -> &<File as Deref>::Target

Dereferences the value.

impl Message for File

type ViewType = FileView

fn from_bytes_iter<I>(iter: I) -> Result<File, PuroroError>where I: Iterator<Item = Result<u8, Error>>,

fn merge_from_bytes_iter<I>(&mut self, iter: I) -> Result<(), PuroroError>where I: Iterator<Item = Result<u8, Error>>,

impl MessageInternal for File

fn merge_from_scoped_bytes_iter<I, 'a>( &mut self, iter: &mut ScopedIter<'a, I> ) -> Result<(), PuroroError>where I: Iterator<Item = Result<u8, Error>>,

fn from_scoped_bytes_iter<I, 'a>( scoped_iter: &mut ScopedIter<'a, I> ) -> Result<Self, PuroroError>where I: Iterator<Item = Result<u8, Error>>, Self: Default,

impl PartialEq<File> for File

fn eq(&self, rhs: &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.