pluginpb

package
v1.34.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 11, 2024 License: BSD-3-Clause Imports: 5 Imported by: 1,551

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CodeGeneratorResponse_Feature_name = map[int32]string{
		0: "FEATURE_NONE",
		1: "FEATURE_PROTO3_OPTIONAL",
		2: "FEATURE_SUPPORTS_EDITIONS",
	}
	CodeGeneratorResponse_Feature_value = map[string]int32{
		"FEATURE_NONE":              0,
		"FEATURE_PROTO3_OPTIONAL":   1,
		"FEATURE_SUPPORTS_EDITIONS": 2,
	}
)

Enum value maps for CodeGeneratorResponse_Feature.

View Source 
var File_google_protobuf_compiler_plugin_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CodeGeneratorRequest 

type CodeGeneratorRequest struct {

	// 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.
	FileToGenerate []string `protobuf:"bytes,1,rep,name=file_to_generate,json=fileToGenerate" json:"file_to_generate,omitempty"`
	// The generator parameter passed on the command-line.
	Parameter *string `protobuf:"bytes,2,opt,name=parameter" json:"parameter,omitempty"`
	// 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.
	ProtoFile []*descriptorpb.FileDescriptorProto `protobuf:"bytes,15,rep,name=proto_file,json=protoFile" json:"proto_file,omitempty"`
	// File descriptors with all options, including source-retention options.
	// These descriptors are only provided for the files listed in
	// files_to_generate.
	SourceFileDescriptors []*descriptorpb.FileDescriptorProto `protobuf:"bytes,17,rep,name=source_file_descriptors,json=sourceFileDescriptors" json:"source_file_descriptors,omitempty"`
	// The version number of protocol compiler.
	CompilerVersion *Version `protobuf:"bytes,3,opt,name=compiler_version,json=compilerVersion" json:"compiler_version,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CodeGeneratorRequest) Descriptor deprecated 

func (*CodeGeneratorRequest) Descriptor() ([]byte, []int)

Deprecated: Use CodeGeneratorRequest.ProtoReflect.Descriptor instead.

func (*CodeGeneratorRequest) GetCompilerVersion 

func (x *CodeGeneratorRequest) GetCompilerVersion() *Version

func (*CodeGeneratorRequest) GetFileToGenerate 

func (x *CodeGeneratorRequest) GetFileToGenerate() []string

func (*CodeGeneratorRequest) GetParameter 

func (x *CodeGeneratorRequest) GetParameter() string

func (*CodeGeneratorRequest) GetProtoFile 

func (x *CodeGeneratorRequest) GetProtoFile() []*descriptorpb.FileDescriptorProto

func (*CodeGeneratorRequest) GetSourceFileDescriptors added in v1.32.0 

func (x *CodeGeneratorRequest) GetSourceFileDescriptors() []*descriptorpb.FileDescriptorProto

func (*CodeGeneratorRequest) ProtoMessage 

func (*CodeGeneratorRequest) ProtoMessage()

func (*CodeGeneratorRequest) ProtoReflect 

func (x *CodeGeneratorRequest) ProtoReflect() protoreflect.Message

func (*CodeGeneratorRequest) Reset 

func (x *CodeGeneratorRequest) Reset()

func (*CodeGeneratorRequest) String 

func (x *CodeGeneratorRequest) String() string

type CodeGeneratorResponse 

type CodeGeneratorResponse struct {

	// 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.
	Error *string `protobuf:"bytes,1,opt,name=error" json:"error,omitempty"`
	// A bitmask of supported features that the code generator supports.
	// This is a bitwise "or" of values from the Feature enum.
	SupportedFeatures *uint64 `protobuf:"varint,2,opt,name=supported_features,json=supportedFeatures" json:"supported_features,omitempty"`
	// 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.
	MinimumEdition *int32 `protobuf:"varint,3,opt,name=minimum_edition,json=minimumEdition" json:"minimum_edition,omitempty"`
	// 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.
	MaximumEdition *int32                        `protobuf:"varint,4,opt,name=maximum_edition,json=maximumEdition" json:"maximum_edition,omitempty"`
	File           []*CodeGeneratorResponse_File `protobuf:"bytes,15,rep,name=file" json:"file,omitempty"`
	// contains filtered or unexported fields
}

The plugin writes an encoded CodeGeneratorResponse to stdout.

func (*CodeGeneratorResponse) Descriptor deprecated 

func (*CodeGeneratorResponse) Descriptor() ([]byte, []int)

Deprecated: Use CodeGeneratorResponse.ProtoReflect.Descriptor instead.

func (*CodeGeneratorResponse) GetError 

func (x *CodeGeneratorResponse) GetError() string

func (*CodeGeneratorResponse) GetFile 

func (x *CodeGeneratorResponse) GetFile() []*CodeGeneratorResponse_File

func (*CodeGeneratorResponse) GetMaximumEdition added in v1.33.0 

func (x *CodeGeneratorResponse) GetMaximumEdition() int32

func (*CodeGeneratorResponse) GetMinimumEdition added in v1.33.0 

func (x *CodeGeneratorResponse) GetMinimumEdition() int32

func (*CodeGeneratorResponse) GetSupportedFeatures added in v1.22.0 

func (x *CodeGeneratorResponse) GetSupportedFeatures() uint64

func (*CodeGeneratorResponse) ProtoMessage 

func (*CodeGeneratorResponse) ProtoMessage()

func (*CodeGeneratorResponse) ProtoReflect 

func (x *CodeGeneratorResponse) ProtoReflect() protoreflect.Message

func (*CodeGeneratorResponse) Reset 

func (x *CodeGeneratorResponse) Reset()

func (*CodeGeneratorResponse) String 

func (x *CodeGeneratorResponse) String() string

type CodeGeneratorResponse_Feature added in v1.22.0 

type CodeGeneratorResponse_Feature int32

Sync with code_generator.h. 

const (
	CodeGeneratorResponse_FEATURE_NONE              CodeGeneratorResponse_Feature = 0
	CodeGeneratorResponse_FEATURE_PROTO3_OPTIONAL   CodeGeneratorResponse_Feature = 1
	CodeGeneratorResponse_FEATURE_SUPPORTS_EDITIONS CodeGeneratorResponse_Feature = 2
)

func (CodeGeneratorResponse_Feature) Descriptor added in v1.22.0 

func (CodeGeneratorResponse_Feature) Descriptor() protoreflect.EnumDescriptor

func (CodeGeneratorResponse_Feature) Enum added in v1.22.0 

func (x CodeGeneratorResponse_Feature) Enum() *CodeGeneratorResponse_Feature

func (CodeGeneratorResponse_Feature) EnumDescriptor deprecated added in v1.22.0 

func (CodeGeneratorResponse_Feature) EnumDescriptor() ([]byte, []int)

Deprecated: Use CodeGeneratorResponse_Feature.Descriptor instead.

func (CodeGeneratorResponse_Feature) Number added in v1.22.0 

func (x CodeGeneratorResponse_Feature) Number() protoreflect.EnumNumber

func (CodeGeneratorResponse_Feature) String added in v1.22.0 

func (x CodeGeneratorResponse_Feature) String() string

func (CodeGeneratorResponse_Feature) Type added in v1.22.0 

func (CodeGeneratorResponse_Feature) Type() protoreflect.EnumType

func (*CodeGeneratorResponse_Feature) UnmarshalJSON deprecated added in v1.22.0 

func (x *CodeGeneratorResponse_Feature) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type CodeGeneratorResponse_File 

type CodeGeneratorResponse_File struct {

	// The file name, relative to the output directory.  The name must not
	// contain "." or ".." components and must be relative, not be absolute (so,
	// the file cannot lie outside the output directory).  "/" must be used as
	// the path separator, not "\".
	//
	// If the name is omitted, the content will be appended to the previous
	// file.  This allows the generator to break large files into small chunks,
	// and allows the generated text to be streamed back to protoc so that large
	// files need not reside completely in memory at one time.  Note that as of
	// this writing protoc does not optimize for this -- it will read the entire
	// CodeGeneratorResponse before writing files to disk.
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// If non-empty, indicates that the named file should already exist, and the
	// content here is to be inserted into that file at a defined insertion
	// point.  This feature allows a code generator to extend the output
	// produced by another code generator.  The original generator may provide
	// insertion points by placing special annotations in the file that look
	// like:
	//
	//	@@protoc_insertion_point(NAME)
	//
	// The annotation can have arbitrary text before and after it on the line,
	// which allows it to be placed in a comment.  NAME should be replaced with
	// an identifier naming the point -- this is what other generators will use
	// as the insertion_point.  Code inserted at this point will be placed
	// immediately above the line containing the insertion point (thus multiple
	// insertions to the same point will come out in the order they were added).
	// The double-@ is intended to make it unlikely that the generated code
	// could contain things that look like insertion points by accident.
	//
	// For example, the C++ code generator places the following line in the
	// .pb.h files that it generates:
	//
	//	// @@protoc_insertion_point(namespace_scope)
	//
	// This line appears within the scope of the file's package namespace, but
	// outside of any particular class.  Another plugin can then specify the
	// insertion_point "namespace_scope" to generate additional classes or
	// other declarations that should be placed in this scope.
	//
	// Note that if the line containing the insertion point begins with
	// whitespace, the same whitespace will be added to every line of the
	// inserted text.  This is useful for languages like Python, where
	// indentation matters.  In these languages, the insertion point comment
	// should be indented the same amount as any inserted code will need to be
	// in order to work correctly in that context.
	//
	// The code generator that generates the initial file and the one which
	// inserts into it must both run as part of a single invocation of protoc.
	// Code generators are executed in the order in which they appear on the
	// command line.
	//
	// If |insertion_point| is present, |name| must also be present.
	InsertionPoint *string `protobuf:"bytes,2,opt,name=insertion_point,json=insertionPoint" json:"insertion_point,omitempty"`
	// The file contents.
	Content *string `protobuf:"bytes,15,opt,name=content" json:"content,omitempty"`
	// Information describing the file content being inserted. If an insertion
	// point is used, this information will be appropriately offset and inserted
	// into the code generation metadata for the generated files.
	GeneratedCodeInfo *descriptorpb.GeneratedCodeInfo `protobuf:"bytes,16,opt,name=generated_code_info,json=generatedCodeInfo" json:"generated_code_info,omitempty"`
	// contains filtered or unexported fields
}

Represents a single generated file.

func (*CodeGeneratorResponse_File) Descriptor deprecated 

func (*CodeGeneratorResponse_File) Descriptor() ([]byte, []int)

Deprecated: Use CodeGeneratorResponse_File.ProtoReflect.Descriptor instead.

func (*CodeGeneratorResponse_File) GetContent 

func (x *CodeGeneratorResponse_File) GetContent() string

func (*CodeGeneratorResponse_File) GetGeneratedCodeInfo added in v1.26.0 

func (x *CodeGeneratorResponse_File) GetGeneratedCodeInfo() *descriptorpb.GeneratedCodeInfo

func (*CodeGeneratorResponse_File) GetInsertionPoint 

func (x *CodeGeneratorResponse_File) GetInsertionPoint() string

func (*CodeGeneratorResponse_File) GetName 

func (x *CodeGeneratorResponse_File) GetName() string

func (*CodeGeneratorResponse_File) ProtoMessage 

func (*CodeGeneratorResponse_File) ProtoMessage()

func (*CodeGeneratorResponse_File) ProtoReflect 

func (x *CodeGeneratorResponse_File) ProtoReflect() protoreflect.Message

func (*CodeGeneratorResponse_File) Reset 

func (x *CodeGeneratorResponse_File) Reset()

func (*CodeGeneratorResponse_File) String 

func (x *CodeGeneratorResponse_File) String() string

type Version 

type Version struct {
	Major *int32 `protobuf:"varint,1,opt,name=major" json:"major,omitempty"`
	Minor *int32 `protobuf:"varint,2,opt,name=minor" json:"minor,omitempty"`
	Patch *int32 `protobuf:"varint,3,opt,name=patch" json:"patch,omitempty"`
	// A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
	// be empty for mainline stable releases.
	Suffix *string `protobuf:"bytes,4,opt,name=suffix" json:"suffix,omitempty"`
	// contains filtered or unexported fields
}

The version number of protocol compiler.

func (*Version) Descriptor deprecated 

func (*Version) Descriptor() ([]byte, []int)

Deprecated: Use Version.ProtoReflect.Descriptor instead.

func (*Version) GetMajor 

func (x *Version) GetMajor() int32

func (*Version) GetMinor 

func (x *Version) GetMinor() int32

func (*Version) GetPatch 

func (x *Version) GetPatch() int32

func (*Version) GetSuffix 

func (x *Version) GetSuffix() string

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) ProtoReflect 

func (x *Version) ProtoReflect() protoreflect.Message

func (*Version) Reset 

func (x *Version) Reset()

func (*Version) String 

func (x *Version) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.