...
ActiveGo 1.8Package plugin_go
Overview ▹
Index ▹
type CodeGeneratorRequest ¶
An encoded CodeGeneratorRequest is written to the plugin's stdin.
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.
//
// 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 []*google_protobuf.FileDescriptorProto `protobuf:"bytes,15,rep,name=proto_file,json=protoFile" json:"proto_file,omitempty"`
// The version number of protocol compiler.
CompilerVersion *Version `protobuf:"bytes,3,opt,name=compiler_version,json=compilerVersion" json:"compiler_version,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
func (*CodeGeneratorRequest) Descriptor ¶
func (*CodeGeneratorRequest) Descriptor() ([]byte, []int)
func (*CodeGeneratorRequest) GetCompilerVersion ¶
func (m *CodeGeneratorRequest) GetCompilerVersion() *Version
func (*CodeGeneratorRequest) GetFileToGenerate ¶
func (m *CodeGeneratorRequest) GetFileToGenerate() []string
func (*CodeGeneratorRequest) GetParameter ¶
func (m *CodeGeneratorRequest) GetParameter() string
func (*CodeGeneratorRequest) GetProtoFile ¶
func (m *CodeGeneratorRequest) GetProtoFile() []*google_protobuf.FileDescriptorProto
func (*CodeGeneratorRequest) ProtoMessage ¶
func (*CodeGeneratorRequest) ProtoMessage()
func (*CodeGeneratorRequest) Reset ¶
func (m *CodeGeneratorRequest) Reset()
func (*CodeGeneratorRequest) String ¶
func (m *CodeGeneratorRequest) String() string
type CodeGeneratorResponse ¶
The plugin writes an encoded CodeGeneratorResponse to stdout.
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"`
File []*CodeGeneratorResponse_File `protobuf:"bytes,15,rep,name=file" json:"file,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
func (*CodeGeneratorResponse) Descriptor ¶
func (*CodeGeneratorResponse) Descriptor() ([]byte, []int)
func (*CodeGeneratorResponse) GetError ¶
func (m *CodeGeneratorResponse) GetError() string
func (*CodeGeneratorResponse) GetFile ¶
func (m *CodeGeneratorResponse) GetFile() []*CodeGeneratorResponse_File
func (*CodeGeneratorResponse) ProtoMessage ¶
func (*CodeGeneratorResponse) ProtoMessage()
func (*CodeGeneratorResponse) Reset ¶
func (m *CodeGeneratorResponse) Reset()
func (*CodeGeneratorResponse) String ¶
func (m *CodeGeneratorResponse) String() string
type CodeGeneratorResponse_File ¶
Represents a single generated 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"`
XXX_unrecognized []byte `json:"-"`
}
func (*CodeGeneratorResponse_File) Descriptor ¶
func (*CodeGeneratorResponse_File) Descriptor() ([]byte, []int)
func (*CodeGeneratorResponse_File) GetContent ¶
func (m *CodeGeneratorResponse_File) GetContent() string
func (*CodeGeneratorResponse_File) GetInsertionPoint ¶
func (m *CodeGeneratorResponse_File) GetInsertionPoint() string
func (*CodeGeneratorResponse_File) GetName ¶
func (m *CodeGeneratorResponse_File) GetName() string
func (*CodeGeneratorResponse_File) ProtoMessage ¶
func (*CodeGeneratorResponse_File) ProtoMessage()
func (*CodeGeneratorResponse_File) Reset ¶
func (m *CodeGeneratorResponse_File) Reset()
func (*CodeGeneratorResponse_File) String ¶
func (m *CodeGeneratorResponse_File) String() string
type Version ¶
The version number of protocol compiler.
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"`
XXX_unrecognized []byte `json:"-"`
}
func (*Version) Descriptor ¶
func (*Version) Descriptor() ([]byte, []int)
func (*Version) GetMajor ¶
func (m *Version) GetMajor() int32
func (*Version) GetMinor ¶
func (m *Version) GetMinor() int32
func (*Version) GetPatch ¶
func (m *Version) GetPatch() int32
func (*Version) GetSuffix ¶
func (m *Version) GetSuffix() string
func (*Version) ProtoMessage ¶
func (*Version) ProtoMessage()
func (*Version) Reset ¶
func (m *Version) Reset()
func (*Version) String ¶
func (m *Version) String() string