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

Generated

from message google.protobuf.compiler.CodeGeneratorRequest

Hierarchy

Constructors

Properties

compilerVersion?: Version

The version number of protocol compiler.

Generated

from field: optional google.protobuf.compiler.Version compiler_version = 3;

fileToGenerate: string[]

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.

Generated

from field: repeated string file_to_generate = 1;

parameter?: string

The generator parameter passed on the command-line.

Generated

from field: optional string parameter = 2;

protoFile: FileDescriptorProto[]

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.

Type names of fields and extensions in the FileDescriptorProto are always fully qualified.

Generated

from field: repeated google.protobuf.FileDescriptorProto proto_file = 15;

fields: FieldList
runtime: ProtoRuntime
typeName: "google.protobuf.compiler.CodeGeneratorRequest" = "google.protobuf.compiler.CodeGeneratorRequest"

Methods

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    Returns CodeGeneratorRequest

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<CodeGeneratorRequest>

  • Serialize the message to binary data.

    Parameters

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    Returns string

  • Parameters

    Returns CodeGeneratorRequest

  • Parameters

    Returns CodeGeneratorRequest

Generated using TypeDoc