metadata

Documentation

Index

• Variables
• type Func
  • func (m *Func) Args() []Var
  • func (m *Func) Doc() string
  • func (m *Func) Fullname() string
  • func (m *Func) Name() string
  • func (m *Func) Returns() []Var
• type Lookup
  • func NewLookup(fset *token.FileSet) *Lookup
  • func (l *Lookup) LookupFromFunc(fn interface{}) (*Func, error)
  • func (l *Lookup) LookupFromFuncForPC(pc uintptr) (*Func, error)
  • func (l *Lookup) LookupFromType(ob interface{}) (*Type, error)
  • func (l *Lookup) LookupFromTypeForReflectType(rt reflect.Type) (*Type, error)
• type Type
  • func (s *Type) Doc() string
  • func (s *Type) FieldComments() map[string]string
  • func (s *Type) Name() string
• type Var

Variables

var DEBUG = false

var ErrNotFound = fmt.Errorf("not found")

ErrNotFound is the error metadata is not found.

var ErrNotSupported = fmt.Errorf("not supported")

ErrNotSupported is the error metadata is not supported, yet

Types

type Func

type Func struct {
	Raw  *collect.Func
	Recv string
	// contains filtered or unexported fields
}

func (*Func) Args

func (m *Func) Args() []Var

func (*Func) Doc

func (m *Func) Doc() string

func (*Func) Fullname

func (m *Func) Fullname() string

func (*Func) Name

func (m *Func) Name() string

func (*Func) Returns

func (m *Func) Returns() []Var

type Lookup

type Lookup struct {
	Fset *token.FileSet

	IncludeGoTestFiles bool
	IncludeUnexported  bool
	// contains filtered or unexported fields
}

func NewLookup

func NewLookup(fset *token.FileSet) *Lookup

func (*Lookup) LookupFromFunc

func (l *Lookup) LookupFromFunc(fn interface{}) (*Func, error)

func (*Lookup) LookupFromFuncForPC

func (l *Lookup) LookupFromFuncForPC(pc uintptr) (*Func, error)

func (*Lookup) LookupFromType

func (l *Lookup) LookupFromType(ob interface{}) (*Type, error)

func (*Lookup) LookupFromTypeForReflectType

func (l *Lookup) LookupFromTypeForReflectType(rt reflect.Type) (*Type, error)

type Type

type Type struct {
	Raw *collect.Object
}

func (*Type) Doc

func (s *Type) Doc() string

func (*Type) FieldComments

func (s *Type) FieldComments() map[string]string

func (*Type) Name

func (s *Type) Name() string

type Var

type Var struct {
	Name string
	Doc  string
}