Version: v0.1.0 Latest Latest

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

Go to latest
Published: Apr 2, 2019 License: BSD-3-Clause Imports: 11 Imported by: 0




This section is empty.


This section is empty.


func Parse

func Parse(filename string, b []byte, opts ...Option) (interface{}, error)

Parse parses the data from b using filename as information in the error messages.

func ParseFile

func ParseFile(filename string, opts ...Option) (interface{}, error)

ParseFile parses the file identified by filename.

func ParseReader

func ParseReader(filename string, r io.Reader, opts ...Option) (interface{}, error)

ParseReader parses the data from r using filename as information in the error messages.


type Annotation

type Annotation struct {
	Name  string
	Value string

type Constant

type Constant struct {
	Name  string
	Type  *Type
	Value interface{}

type Enum

type Enum struct {
	Name        string
	Values      map[string]*EnumValue
	Annotations []*Annotation

type EnumValue

type EnumValue struct {
	Name        string
	Value       int
	Annotations []*Annotation

type Field

type Field struct {
	ID          int
	Name        string
	Optional    bool
	Type        *Type
	Default     interface{}
	Annotations []*Annotation

type Filesystem

type Filesystem interface {
	Open(filename string) (io.ReadCloser, error)
	Abs(path string) (string, error)

type Identifier

type Identifier string

type KeyValue

type KeyValue struct {
	Key, Value interface{}

type Method

type Method struct {
	Comment     string
	Name        string
	Oneway      bool
	ReturnType  *Type
	Arguments   []*Field
	Exceptions  []*Field
	Annotations []*Annotation

type Option

type Option func(*parser) Option

Option is a function that can set an option on the parser. It returns the previous setting as an Option.

func Debug

func Debug(b bool) Option

Debug creates an Option to set the debug flag to b. When set to true, debugging information is printed to stdout while parsing.

The default is false.

func Memoize

func Memoize(b bool) Option

Memoize creates an Option to set the memoize flag to b. When set to true, the parser will cache all results so each expression is evaluated only once. This guarantees linear parsing time even for pathological cases, at the expense of more memory and slower times for typical cases.

The default is false.

func Recover

func Recover(b bool) Option

Recover creates an Option to set the recover flag to b. When set to true, this causes the parser to recover from panics and convert it to an error. Setting it to false can be useful while debugging to access the full stack trace.

The default is true.

type Parser

type Parser struct {
	Filesystem Filesystem // For handling includes. Can be set to nil to fall back to os package.

func (*Parser) Parse

func (p *Parser) Parse(r io.Reader, opts ...Option) (*Thrift, error)

func (*Parser) ParseFile

func (p *Parser) ParseFile(filename string) (map[string]*Thrift, string, error)

type Service

type Service struct {
	Name        string
	Extends     string
	Methods     map[string]*Method
	Annotations []*Annotation

type Struct

type Struct struct {
	Name        string
	Fields      []*Field
	Annotations []*Annotation

type Thrift

type Thrift struct {
	Includes   map[string]string // name -> unique identifier (absolute path generally)
	Typedefs   map[string]*Typedef
	Namespaces map[string]string
	Constants  map[string]*Constant
	Enums      map[string]*Enum
	Structs    map[string]*Struct
	Exceptions map[string]*Struct
	Unions     map[string]*Struct
	Services   map[string]*Service

type Type

type Type struct {
	Name        string
	KeyType     *Type // If map
	ValueType   *Type // If map, list, or set
	Annotations []*Annotation

func (*Type) String

func (t *Type) String() string

type Typedef

type Typedef struct {

	Alias       string
	Annotations []*Annotation

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL