Packages

final case class CodeGeneratorRequest(fileToGenerate: Seq[String] = _root_.scala.collection.Seq.empty, parameter: scala.Option[String] = None, protoFile: Seq[FileDescriptorProto] = _root_.scala.collection.Seq.empty) 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, scala.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] = _root_.scala.collection.Seq.empty, parameter: scala.Option[String] = None, protoFile: Seq[FileDescriptorProto] = _root_.scala.collection.Seq.empty)

    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: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllFileToGenerate(__vs: TraversableOnce[String]): CodeGeneratorRequest
  5. def addAllProtoFile(__vs: TraversableOnce[FileDescriptorProto]): CodeGeneratorRequest
  6. def addFileToGenerate(__vs: String*): CodeGeneratorRequest
  7. def addProtoFile(__vs: FileDescriptorProto*): CodeGeneratorRequest
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearFileToGenerate: CodeGeneratorRequest
  10. def clearParameter: CodeGeneratorRequest
  11. def clearProtoFile: CodeGeneratorRequest
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def companion: CodeGeneratorRequest.type
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. val fileToGenerate: Seq[String]
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  19. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  20. def getParameter: String
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def mergeFrom(_input__: CodedInputStream): CodeGeneratorRequest
    Definition Classes
    CodeGeneratorRequestMessage
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  26. val parameter: scala.Option[String]
  27. val protoFile: Seq[FileDescriptorProto]
  28. final def serializedSize: Int
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  31. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  32. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  33. def toString(): String
    Definition Classes
    CodeGeneratorRequest → AnyRef → Any
  34. def update(ms: (Lens[CodeGeneratorRequest, CodeGeneratorRequest]) ⇒ Mutation[CodeGeneratorRequest]*): CodeGeneratorRequest
    Definition Classes
    Updatable
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def withFileToGenerate(__v: Seq[String]): CodeGeneratorRequest
  39. def withParameter(__v: String): CodeGeneratorRequest
  40. def withProtoFile(__v: Seq[FileDescriptorProto]): CodeGeneratorRequest
  41. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  42. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    CodeGeneratorRequestGeneratedMessage
  43. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, scala.Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): scala.Any
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[CodeGeneratorRequest]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from scala.Any

Ungrouped