Package

com.google.protobuf.compiler

plugin

Permalink

package plugin

Visibility
  1. Public
  2. All

Type Members

  1. 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

    Permalink

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

    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()
  2. final case class CodeGeneratorResponse(error: Option[String] = None, file: Seq[File] = Nil) extends trueaccord.scalapb.GeneratedMessage with trueaccord.scalapb.Message[CodeGeneratorResponse] with Updatable[CodeGeneratorResponse] with Product with Serializable

    Permalink

    The plugin writes an encoded CodeGeneratorResponse to stdout.

    The plugin writes an encoded CodeGeneratorResponse to stdout.

    error

    Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way. This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself -- such as the input CodeGeneratorRequest being unparseable -- should be reported by writing a message to stderr and exiting with a non-zero status code.

    Annotations
    @SerialVersionUID()

Ungrouped