CodeGeneratorResponse

com.google.protobuf.compiler.plugin.CodeGeneratorResponse
See theCodeGeneratorResponse companion class

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[CodeGeneratorResponse, CodeGeneratorResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

implicit class CodeGeneratorResponseLens[UpperPB](_l: Lens[UpperPB, CodeGeneratorResponse]) extends ObjectLens[UpperPB, CodeGeneratorResponse]

Attributes

Supertypes
class ObjectLens[UpperPB, CodeGeneratorResponse]
trait Lens[UpperPB, CodeGeneratorResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed abstract class Feature(val value: Int) extends GeneratedEnum

Sync with code_generator.h.

Sync with code_generator.h.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Feature.type
final case class File(name: Option[String], insertionPoint: Option[String], content: Option[String], generatedCodeInfo: Option[GeneratedCodeInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[File]

Represents a single generated file.

Represents a single generated file.

Value parameters

content

The file contents.

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.

insertionPoint

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.

name

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 "&92;". 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.

Attributes

Companion
object
Supertypes
trait Updatable[File]
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[File, File]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
File.type

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Attributes

Inherited from:
GeneratedMessageCompanion

Value members

Concrete methods

def enumCompanionForFieldNumber(`__fieldNumber`: Int): GeneratedEnumCompanion[_]
def fromJavaProto(javaPbSource: CodeGeneratorResponse): CodeGeneratorResponse
def javaDescriptor: Descriptor

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Attributes

def of(error: Option[String], supportedFeatures: Option[Long], minimumEdition: Option[Int], maximumEdition: Option[Int], file: Seq[File]): CodeGeneratorResponse
def parseFrom(`_input__`: CodedInputStream): CodeGeneratorResponse

Parses a message from a CodedInputStream.

Parses a message from a CodedInputStream.

Attributes

def toJavaProto(scalaPbSource: CodeGeneratorResponse): CodeGeneratorResponse

Inherited methods

def enumCompanionForField(field: FieldDescriptor): GeneratedEnumCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion

Attributes

Inherited from:
GeneratedMessageCompanion
def merge(a: CodeGeneratorResponse, input: CodedInputStream): CodeGeneratorResponse

Merges the given message with the additional fields in the steam.

Merges the given message with the additional fields in the steam.

Attributes

Inherited from:
GeneratedMessageCompanion
def messageCompanionForField(field: FieldDescriptor): GeneratedMessageCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: InputStream): Option[CodeGeneratorResponse]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: CodedInputStream): Option[CodeGeneratorResponse]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(s: Array[Byte]): CodeGeneratorResponse

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(input: InputStream): CodeGeneratorResponse

Attributes

Inherited from:
GeneratedMessageCompanion
def streamFromDelimitedInput(input: InputStream): Stream[CodeGeneratorResponse]

Attributes

Inherited from:
GeneratedMessageCompanion
def toByteArray(a: CodeGeneratorResponse): Array[Byte]

Attributes

Inherited from:
GeneratedMessageCompanion
def validate(s: Array[Byte]): Try[CodeGeneratorResponse]

Attributes

Inherited from:
GeneratedMessageCompanion

Attributes

Inherited from:
GeneratedMessageCompanion

Implicits