parse

Documentation

Index

• Variables
• type Field
• type Func
• type Package
  • func Parse(dir string) (pkg Package, err error)
• type Type

Variables

var (
	// ErrExpectedOnePackage is returned when multiple packages are found for the
	// provided directory location
	ErrExpectedOnePackage = errors.New("expected to find one package")
)

Types

type Field

type Field struct {
	Name string
	Type string
	Tags map[string]string
}

Field represents a field in a struct which have a name and function option name to be used

type Func

type Func struct {
	Name string
}

Func represntes function definition

type Package

type Package struct {
	Name  string
	Types map[string]Type
}

Package contains the packages name and the types relevant for generating against

func Parse

func Parse(dir string) (pkg Package, err error)

Parse parses a director, expecting to find a single package It returns a Go representation of the package with the minimal information required for generating options code

type Type

type Type struct {
	Name   string
	Fields []Field
	Funcs  []Func
}

Type represents a struct type with a name and some associated fields