anmolitor / elm-protoc-types / Proto.Google.Protobuf.Compiler

This file was automatically generated by

To run it, add a dependency via elm install on elm-protocol-buffers version latest or higher.

Protocol Buffers - Google's data interchange format Copyright 2008 Google Inc. All rights reserved. https://developers.google.com/protocol-buffers/

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Author: kenton


type alias CodeGeneratorRequest =
Internals_.Proto__Google__Protobuf__Compiler__CodeGeneratorRequest

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

Fields

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.

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

compilerVersion

The version number of protocol compiler.


type alias CodeGeneratorResponse =
Internals_.Proto__Google__Protobuf__Compiler__CodeGeneratorResponse

The plugin writes an encoded CodeGeneratorResponse to stdout.

Fields

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.


type alias Version =
Internals_.Proto__Google__Protobuf__Compiler__Version

The version number of protocol compiler.

Fields

suffix

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

decodeCodeGeneratorRequest : Protobuf.Decode.Decoder CodeGeneratorRequest

Declares how to decode a CodeGeneratorRequest from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

decodeCodeGeneratorResponse : Protobuf.Decode.Decoder CodeGeneratorResponse

Declares how to decode a CodeGeneratorResponse from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

decodeVersion : Protobuf.Decode.Decoder Version

Declares how to decode a Version from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

defaultCodeGeneratorRequest : CodeGeneratorRequest

Default for CodeGeneratorRequest. Should only be used for 'required' decoders as an initial value.

defaultCodeGeneratorResponse : CodeGeneratorResponse

Default for CodeGeneratorResponse. Should only be used for 'required' decoders as an initial value.

defaultVersion : Version

Default for Version. Should only be used for 'required' decoders as an initial value.

encodeCodeGeneratorRequest : CodeGeneratorRequest -> Protobuf.Encode.Encoder

Declares how to encode a CodeGeneratorRequest to Bytes. To actually perform the conversion to Bytes, you need to use Protobuf.Encode.encode from eriktim/elm-protocol-buffers.

encodeCodeGeneratorResponse : CodeGeneratorResponse -> Protobuf.Encode.Encoder

Declares how to encode a CodeGeneratorResponse to Bytes. To actually perform the conversion to Bytes, you need to use Protobuf.Encode.encode from eriktim/elm-protocol-buffers.

encodeVersion : Version -> Protobuf.Encode.Encoder

Declares how to encode a Version to Bytes. To actually perform the conversion to Bytes, you need to use Protobuf.Encode.encode from eriktim/elm-protocol-buffers.

fieldNumbersCodeGeneratorRequest : { fileToGenerate : Basics.Int, parameter : Basics.Int, protoFile : Basics.Int, compilerVersion : Basics.Int }

The field numbers for the fields of CodeGeneratorRequest. This is mostly useful for internals, like documentation generation.

fieldNumbersCodeGeneratorResponse : { error : Basics.Int, supportedFeatures : Basics.Int, file : Basics.Int }

The field numbers for the fields of CodeGeneratorResponse. This is mostly useful for internals, like documentation generation.

fieldNumbersVersion : { major : Basics.Int, minor : Basics.Int, patch : Basics.Int, suffix : Basics.Int }

The field numbers for the fields of Version. This is mostly useful for internals, like documentation generation.

jsonDecodeCodeGeneratorRequest : Json.Decode.Decoder CodeGeneratorRequest

Declares how to decode a CodeGeneratorRequest from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

jsonDecodeCodeGeneratorResponse : Json.Decode.Decoder CodeGeneratorResponse

Declares how to decode a CodeGeneratorResponse from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

jsonDecodeVersion : Json.Decode.Decoder Version

Declares how to decode a Version from Bytes. To actually perform the conversion from Bytes, you need to use Protobuf.Decode.decode from eriktim/elm-protocol-buffers.

jsonEncodeCodeGeneratorRequest : CodeGeneratorRequest -> Json.Encode.Value

Encode a CodeGeneratorRequest to JSON. Uses the canonical encoding described here: https://protobuf.dev/programming-guides/proto3/#json

jsonEncodeCodeGeneratorResponse : CodeGeneratorResponse -> Json.Encode.Value

Encode a CodeGeneratorResponse to JSON. Uses the canonical encoding described here: https://protobuf.dev/programming-guides/proto3/#json

jsonEncodeVersion : Version -> Json.Encode.Value

Encode a Version to JSON. Uses the canonical encoding described here: https://protobuf.dev/programming-guides/proto3/#json