Class/Object

com.google.protobuf.compiler.plugin

CodeGeneratorRequest

Related Docs: object CodeGeneratorRequest | package plugin

Permalink

final case class CodeGeneratorRequest(fileToGenerate: Seq[String] = Nil, parameter: Option[String] = None, protoFile: Seq[FileDescriptorProto] = Nil) extends trueaccord.scalapb.GeneratedMessage with trueaccord.scalapb.Message[CodeGeneratorRequest] with Updatable[CodeGeneratorRequest] with Product with Serializable

An encoded CodeGeneratorRequest is written to the plugin's stdin.

fileToGenerate

The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.

parameter

The generator parameter passed on the command-line.

protoFile

FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[CodeGeneratorRequest], trueaccord.scalapb.Message[CodeGeneratorRequest], trueaccord.scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CodeGeneratorRequest
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CodeGeneratorRequest(fileToGenerate: Seq[String] = Nil, parameter: Option[String] = None, protoFile: Seq[FileDescriptorProto] = Nil)

    Permalink

    fileToGenerate

    The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.

    parameter

    The generator parameter passed on the command-line.

    protoFile

    FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addAllFileToGenerate(__vs: TraversableOnce[String]): CodeGeneratorRequest

    Permalink
  5. def addAllProtoFile(__vs: TraversableOnce[FileDescriptorProto]): CodeGeneratorRequest

    Permalink
  6. def addFileToGenerate(__vs: String*): CodeGeneratorRequest

    Permalink
  7. def addProtoFile(__vs: FileDescriptorProto*): CodeGeneratorRequest

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clearFileToGenerate: CodeGeneratorRequest

    Permalink
  10. def clearParameter: CodeGeneratorRequest

    Permalink
  11. def clearProtoFile: CodeGeneratorRequest

    Permalink
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def companion: CodeGeneratorRequest.type

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. val fileToGenerate: Seq[String]

    Permalink

    The .proto files that were explicitly listed on the command-line.

    The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def getField(__field: FieldDescriptor): Any

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  20. def getParameter: String

    Permalink
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def mergeFrom(_input__: CodedInputStream): CodeGeneratorRequest

    Permalink
    Definition Classes
    CodeGeneratorRequestMessage
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. val parameter: Option[String]

    Permalink

    The generator parameter passed on the command-line.

  27. val protoFile: Seq[FileDescriptorProto]

    Permalink

    FileDescriptorProtos for all files in files_to_generate and everything they import.

    FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin.

  28. final def serializedSize: Int

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage
  31. def toString(): String

    Permalink
    Definition Classes
    CodeGeneratorRequest → AnyRef → Any
  32. def update(ms: (Lens[CodeGeneratorRequest, CodeGeneratorRequest]) ⇒ Mutation[CodeGeneratorRequest]*): CodeGeneratorRequest

    Permalink
    Definition Classes
    Updatable
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def withFileToGenerate(__v: Seq[String]): CodeGeneratorRequest

    Permalink
  37. def withParameter(__v: String): CodeGeneratorRequest

    Permalink
  38. def withProtoFile(__v: Seq[FileDescriptorProto]): CodeGeneratorRequest

    Permalink
  39. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage
  40. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  41. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[CodeGeneratorRequest]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped