Class CodeGeneratorResponse.Types.File (3.23.0) 

public sealed class CodeGeneratorResponse.Types.File : IMessage<CodeGeneratorResponse.Types.File>, IEquatable<CodeGeneratorResponse.Types.File>, IDeepCloneable<CodeGeneratorResponse.Types.File>, IBufferMessage, IMessage

Represents a single generated file.

Inheritance

object > CodeGeneratorResponse.Types.File

Namespace

Google.Protobuf.Compiler

Assembly

Google.Protobuf.dll

Constructors

File()

public File()

File(File)

public File(CodeGeneratorResponse.Types.File other)
Parameter
Name Description
other CodeGeneratorResponseTypesFile

Fields

ContentFieldNumber

public const int ContentFieldNumber = 15

Field number for the "content" field.

Field Value
Type Description
int

GeneratedCodeInfoFieldNumber

public const int GeneratedCodeInfoFieldNumber = 16

Field number for the "generated_code_info" field.

Field Value
Type Description
int

InsertionPointFieldNumber

public const int InsertionPointFieldNumber = 2

Field number for the "insertion_point" field.

Field Value
Type Description
int

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type Description
int

Properties

Content

public string Content { get; set; }

The file contents.

Property Value
Type Description
string

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

GeneratedCodeInfo

public GeneratedCodeInfo GeneratedCodeInfo { get; set; }

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.

Property Value
Type Description
GeneratedCodeInfo

HasContent

public bool HasContent { get; }

Gets whether the "content" field is set

Property Value
Type Description
bool

HasInsertionPoint

public bool HasInsertionPoint { get; }

Gets whether the "insertion_point" field is set

Property Value
Type Description
bool

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type Description
bool

InsertionPoint

public string InsertionPoint { get; set; }

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.

Property Value
Type Description
string

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

Parser

public static MessageParser<CodeGeneratorResponse.Types.File> Parser { get; }
Property Value
Type Description
MessageParserCodeGeneratorResponseTypesFile

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

ClearContent()

public void ClearContent()

Clears the value of the "content" field

ClearInsertionPoint()

public void ClearInsertionPoint()

Clears the value of the "insertion_point" field

ClearName()

public void ClearName()

Clears the value of the "name" field

Clone()

public CodeGeneratorResponse.Types.File Clone()

Creates a deep clone of this object.

Returns
Type Description
CodeGeneratorResponseTypesFile

A deep clone of this object.

Equals(File)

public bool Equals(CodeGeneratorResponse.Types.File other)
Parameter
Name Description
other CodeGeneratorResponseTypesFile
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

MergeFrom(File)

public void MergeFrom(CodeGeneratorResponse.Types.File other)

Merges the given message into this one.

Parameter
Name Description
other CodeGeneratorResponseTypesFile
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.

Extension Methods