parser

Documentation

Index

• Variables
• type Constant
• type Enum
• type EnumValue
• type ErrSyntaxError
  • func (e *ErrSyntaxError) Error() string
• type Field
• type Filesystem
• type Method
• type Parser
  • func (p *Parser) Parse(r io.Reader) (*Thrift, error)
  • func (p *Parser) ParseFile(filename string) (map[string]*Thrift, string, error)
• type Service
• type Struct
• type Thrift
• type Type

Variables

var (
	ErrParserFail = errors.New("thrift.parser: parsing failed entirely")
)

Types

type Constant

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

type Enum

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

type EnumValue

type EnumValue struct {
	Name  string
	Value int
}

type ErrSyntaxError

type ErrSyntaxError struct {
	File   string
	Line   int
	Column int
	Offset int
	Left   string
}

func (*ErrSyntaxError) Error

func (e *ErrSyntaxError) Error() string

type Field

type Field struct {
	Id       int
	Name     string
	Optional bool
	Type     *Type
	Default  interface{}
}

type Filesystem

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

type Method

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

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) (*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
}

type Struct

type Struct struct {
	Name   string
	Fields []*Field
}

type Thrift

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

type Type

type Type struct {
	Name      string
	KeyType   *Type // If map
	ValueType *Type // If map or list
}