idl

Documentation

Index

• func LoadFile(pkg *model.Package, filePath string)
• type Controller
• type Field
• type Interface
• type Method
• type Package
• type Struct
• type Unit
  • func ParseFile(filename string) (*Unit, error)

Functions

func LoadFile

func LoadFile(pkg *model.Package, filePath string)

Types

type Controller

type Controller struct {
	Name    string   `hcl:"name,label"`
	Doc     *string  `hcl:"doc"`
	Extends []string `hcl:"extends,optional"`
	Methods []Method `hcl:"method,block"`
}

type Field

type Field struct {
	Name     string  `hcl:"name,label"`
	Doc      *string `hcl:"doc"`
	Type     string  `hcl:"type,label"`
	Required *bool   `hcl:"required"`
	Nullable *bool   `hcl:"nullable"`
}

type Interface

type Interface struct {
	Name    string   `hcl:"name,label"`
	Doc     *string  `hcl:"doc"`
	Extends []string `hcl:"extends,optional"`
	Methods []Method `hcl:"method,block"`
}

type Method

type Method struct {
	Name    string  `hcl:"name,label"`
	Doc     *string `hcl:"doc"`
	Inputs  []Field `hcl:"input,block"`
	Outputs []Field `hcl:"output,block"`
}

type Package

type Package struct {
	Path string
	Unit
}

type Struct

type Struct struct {
	Name   string  `hcl:"name,label"`
	Doc    *string `hcl:"doc"`
	Fields []Field `hcl:"field,block"`
}

type Unit

type Unit struct {
	Interfaces []Interface `hcl:"interface,block"`
	Structs    []Struct    `hcl:"struct,block"`
}

func ParseFile

func ParseFile(filename string) (*Unit, error)