Packages

package plugin

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. final case class CodeGeneratorRequest(fileToGenerate: Seq[String] = _root_.scala.Seq.empty, parameter: scala.Option[String] = _root_.scala.None, protoFile: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, sourceFileDescriptors: Seq[FileDescriptorProto] = _root_.scala.Seq.empty, compilerVersion: scala.Option[Version] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[CodeGeneratorRequest] with Product with Serializable

    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. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. 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. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.

    sourceFileDescriptors

    File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.

    compilerVersion

    The version number of protocol compiler.

    Annotations
    @SerialVersionUID()
  2. final case class CodeGeneratorResponse(error: scala.Option[String] = _root_.scala.None, supportedFeatures: scala.Option[Long] = _root_.scala.None, minimumEdition: scala.Option[Int] = _root_.scala.None, maximumEdition: scala.Option[Int] = _root_.scala.None, file: Seq[File] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[CodeGeneratorResponse] with Product with Serializable

    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.

    supportedFeatures

    A bitmask of supported features that the code generator supports. This is a bitwise "or" of values from the Feature enum.

    minimumEdition

    The minimum edition this plugin supports. This will be treated as an Edition enum, but we want to allow unknown values. It should be specified according the edition enum value, *not* the edition number. Only takes effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.

    maximumEdition

    The maximum edition this plugin supports. This will be treated as an Edition enum, but we want to allow unknown values. It should be specified according the edition enum value, *not* the edition number. Only takes effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.

    Annotations
    @SerialVersionUID()
  3. final case class Version(major: scala.Option[Int] = _root_.scala.None, minor: scala.Option[Int] = _root_.scala.None, patch: scala.Option[Int] = _root_.scala.None, suffix: scala.Option[String] = _root_.scala.None, unknownFields: scalapb.UnknownFieldSet = ...) extends scalapb.GeneratedMessage with Updatable[Version] with Product with Serializable

    The version number of protocol compiler.

    The version number of protocol compiler.

    suffix

    A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should be empty for mainline stable releases.

    Annotations
    @SerialVersionUID()

Ungrouped