Documentation
¶
Index ¶
- Constants
- Variables
- func InsertionPoint(names ...string) string
- func Marshal(data Writer) ([]byte, error)
- func MarshalRequest(data *Request) ([]byte, error)
- func MarshalResponse(data *Response) ([]byte, error)
- func Pack(opts []Option) (ss []string)
- func Unmarshal(data Reader, bs []byte) error
- type Desc
- type Generated
- func (p *Generated) GetContent() string
- func (p *Generated) GetInsertionPoint() string
- func (p *Generated) GetName() string
- func (p *Generated) IsSetInsertionPoint() bool
- func (p *Generated) IsSetName() bool
- func (p *Generated) Read(iprot thrift.TProtocol) error
- func (p *Generated) ReadField1(iprot thrift.TProtocol) error
- func (p *Generated) ReadField2(iprot thrift.TProtocol) error
- func (p *Generated) ReadField3(iprot thrift.TProtocol) error
- func (p *Generated) String() string
- func (p *Generated) Write(oprot thrift.TProtocol) error
- type Option
- type Plugin
- type Reader
- type Request
- func (p *Request) GetAST() *parser.Thrift
- func (p *Request) GetGeneratorParameters() []string
- func (p *Request) GetLanguage() string
- func (p *Request) GetOutputPath() string
- func (p *Request) GetPluginParameters() []string
- func (p *Request) GetRecursive() bool
- func (p *Request) GetVersion() string
- func (p *Request) IsSetAST() bool
- func (p *Request) Read(iprot thrift.TProtocol) error
- func (p *Request) ReadField1(iprot thrift.TProtocol) error
- func (p *Request) ReadField2(iprot thrift.TProtocol) error
- func (p *Request) ReadField3(iprot thrift.TProtocol) error
- func (p *Request) ReadField4(iprot thrift.TProtocol) error
- func (p *Request) ReadField5(iprot thrift.TProtocol) error
- func (p *Request) ReadField6(iprot thrift.TProtocol) error
- func (p *Request) ReadField7(iprot thrift.TProtocol) error
- func (p *Request) String() string
- func (p *Request) Write(oprot thrift.TProtocol) error
- type Response
- func (p *Response) GetContents() []*Generated
- func (p *Response) GetError() string
- func (p *Response) GetWarnings() []string
- func (p *Response) IsSetContents() bool
- func (p *Response) IsSetError() bool
- func (p *Response) IsSetWarnings() bool
- func (p *Response) Read(iprot thrift.TProtocol) error
- func (p *Response) ReadField1(iprot thrift.TProtocol) error
- func (p *Response) ReadField2(iprot thrift.TProtocol) error
- func (p *Response) ReadField3(iprot thrift.TProtocol) error
- func (p *Response) String() string
- func (p *Response) Write(oprot thrift.TProtocol) error
- type Writer
Constants ¶
View Source
const InsertionPointFormat = "@@thriftgo_insertion_point(%s)"
InsertionPointFormat is the format for insertion points.
Variables ¶
View Source
var Generated_InsertionPoint_DEFAULT string
View Source
var Generated_Name_DEFAULT string
View Source
var MaxExecutionTime = time.Minute
MaxExecutionTime is a timeout for executing external plugins.
View Source
var Request_AST_DEFAULT *parser.Thrift
View Source
var Response_Contents_DEFAULT []*Generated
View Source
var Response_Error_DEFAULT string
View Source
var Response_Warnings_DEFAULT []string
Functions ¶
func InsertionPoint ¶
InsertionPoint returns a new insertion point.
Types ¶
type Desc ¶
Desc can be used to describes the interface of a plugin or a generator backend.
func ParseCompactArguments ¶
ParseCompactArguments parses a compact form option into arguments. A compact form option is like:
name:key1=val1,key2,key3=val3
This function barely checks the validity of the string, so the user should always provide a valid input.
type Generated ¶
type Generated struct {
Content string `thrift:"Content,1,required" db:"Content" json:"Content"`
Name *string `thrift:"Name,2" db:"Name" json:"Name,omitempty"`
InsertionPoint *string `thrift:"InsertionPoint,3" db:"InsertionPoint" json:"InsertionPoint,omitempty"`
}
Attributes:
- Content
- Name
- InsertionPoint
func NewGenerated ¶
func NewGenerated() *Generated
func (*Generated) GetContent ¶
func (*Generated) GetInsertionPoint ¶
func (*Generated) IsSetInsertionPoint ¶
type Plugin ¶
type Plugin interface {
// Name returns the name of the plugin.
Name() string
// Execute invokes the plugin and waits for response.
Execute(req *Request) (res *Response)
}
Plugin .
type Request ¶
type Request struct {
Version string `thrift:"Version,1,required" db:"Version" json:"Version"`
GeneratorParameters []string `thrift:"GeneratorParameters,2,required" db:"GeneratorParameters" json:"GeneratorParameters"`
PluginParameters []string `thrift:"PluginParameters,3,required" db:"PluginParameters" json:"PluginParameters"`
Language string `thrift:"Language,4,required" db:"Language" json:"Language"`
OutputPath string `thrift:"OutputPath,5,required" db:"OutputPath" json:"OutputPath"`
Recursive bool `thrift:"Recursive,6,required" db:"Recursive" json:"Recursive"`
AST *parser.Thrift `thrift:"AST,7,required" db:"AST" json:"AST"`
}
Attributes:
- Version
- GeneratorParameters
- PluginParameters
- Language
- OutputPath
- Recursive
- AST
func NewRequest ¶
func NewRequest() *Request
func (*Request) GetGeneratorParameters ¶
func (*Request) GetLanguage ¶
func (*Request) GetOutputPath ¶
func (*Request) GetPluginParameters ¶
func (*Request) GetRecursive ¶
func (*Request) GetVersion ¶
type Response ¶
type Response struct {
Error *string `thrift:"Error,1" db:"Error" json:"Error,omitempty"`
Contents []*Generated `thrift:"Contents,2" db:"Contents" json:"Contents,omitempty"`
Warnings []string `thrift:"Warnings,3" db:"Warnings" json:"Warnings,omitempty"`
}
Attributes:
- Error
- Contents
- Warnings
func BuildErrorResponse ¶
BuildErrorResponse creates a plugin response with a error message.
func NewResponse ¶
func NewResponse() *Response
func (*Response) GetContents ¶
func (*Response) GetWarnings ¶
func (*Response) IsSetContents ¶
func (*Response) IsSetError ¶
func (*Response) IsSetWarnings ¶
Click to show internal directories.
Click to hide internal directories.