core

Documentation

Index

• Constants
• func Logus(format string, v ...interface{})
• func RegisterGenerators(gs ...Generator)
• func RegisterParsers(ps ...Parser)
• type Descriptors
  • func (d Descriptors) Exist(iface *IfaceDescriptor) bool
  • func (d Descriptors) Get(group string) (IfaceDescriptors, bool)
  • func (d Descriptors) GroupFrom(key string) string
  • func (d Descriptors) Put(iface *IfaceDescriptor) error
• type EngineInfo
• type FieldDescriptor
  • func (f *FieldDescriptor) AnyHttpMethods() []string
  • func (f *FieldDescriptor) HttpMethodArgs() string
  • func (f *FieldDescriptor) JustHttpAny() bool
  • func (f *FieldDescriptor) NotHttpAny() bool
• type Generator
  • func DefaultGenerator() Generator
  • func GeneratorByName(name string) Generator
• type GeneratorOpts
• type IfaceDescriptor
  • func (d *IfaceDescriptor) SetPkgName(name string)
• type IfaceDescriptors
• type InitOpts
  • func InitFrom(opts Options) *InitOpts
  • func (opts *InitOpts) GeneratorOpts() *GeneratorOpts
  • func (opts *InitOpts) ParserOpts() *ParserOpts
• type MirCtx
• type Option
  • func Cleanup(enable bool) Option
  • func DefaultTag(tag string) Option
  • func EngineImportAlias(name string) Option
  • func EnginePkgName(pkgName string) Option
  • func GeneratorName(name string) Option
  • func NoneQuery(enable bool) Option
  • func ParserName(name string) Option
  • func RunMode(mode runMode) Option
  • func SinkPath(path string) Option
• type Options
  • func (opts Options) InitOpts() *InitOpts
• type Parser
  • func DefaultParser() Parser
  • func ParserByName(name string) Parser
• type ParserOpts

Constants

const (
	// run mode list
	InSerialMode runMode = iota
	InConcurrentMode
	InSerialDebugMode
	InConcurrentDebugMode

	// generator Names
	GeneratorGin        = "gin"
	GeneratorChi        = "chi"
	GeneratorMux        = "mux"
	GeneratorEcho       = "echo"
	GeneratorIris       = "iris"
	GeneratorFiber      = "fiber"
	GeneratorFiberV2    = "fiberV2"
	GeneratorMacaron    = "macaron"
	GeneratorHttpRouter = "httprouter"

	// parser Names
	ParserStructTag = "structTag"
)

Functions

func Logus

func Logus(format string, v ...interface{})

Logus print log info

func RegisterGenerators

func RegisterGenerators(gs ...Generator)

RegisterGenerators register generators

func RegisterParsers

func RegisterParsers(ps ...Parser)

RegisterParsers register parsers

Types

type Descriptors

type Descriptors map[string]IfaceDescriptors

Descriptors mir's Descriptor map {group: IfaceDescriptors}

func (Descriptors) Exist

func (d Descriptors) Exist(iface *IfaceDescriptor) bool

Exist whether exist *IfaceDescriptor sub-item

func (Descriptors) Get

func (d Descriptors) Get(group string) (IfaceDescriptors, bool)

Get get a IfaceDescriptors if exists

func (Descriptors) GroupFrom

func (d Descriptors) GroupFrom(key string) string

GroupFrom return group name from key

func (Descriptors) Put

func (d Descriptors) Put(iface *IfaceDescriptor) error

Put add a IfaceDescriptor Notice: if exist same instance by TypeName will override the old one

type EngineInfo

type EngineInfo struct {
	PkgName     string
	ImportAlias string // import alias name
}

EngineInfo Engine information

type FieldDescriptor

type FieldDescriptor struct {
	Host       string
	Path       string
	Queries    []string
	HttpMethod string
	MethodName string
	Comment    string // not support now so always empty
}

FieldDescriptor field Descriptor info

func (*FieldDescriptor) AnyHttpMethods

func (f *FieldDescriptor) AnyHttpMethods() []string

AnyHttpMethods return methods in HttpMethods Note this is assumed HttpMethods like ANY:POST,GET,HEAD

func (*FieldDescriptor) HttpMethodArgs

func (f *FieldDescriptor) HttpMethodArgs() string

HttpMethodArgs return http method as argument like "POST","GET","HEAD" Note this is assumed HttpMethods like ANY:POST,GET,HEAD

func (*FieldDescriptor) JustHttpAny

func (f *FieldDescriptor) JustHttpAny() bool

JustHttpAny not just http any method

func (*FieldDescriptor) NotHttpAny

func (f *FieldDescriptor) NotHttpAny() bool

NotHttpAny not just http any method

type Generator

type Generator interface {
	Name() string
	Init(opts *GeneratorOpts) error
	Generate(Descriptors) error
	GenerateContext(ctx MirCtx)
	Clone() Generator
}

Generator generate interface code for engine

func DefaultGenerator

func DefaultGenerator() Generator

DefaultGenerator get a default generator

func GeneratorByName

func GeneratorByName(name string) Generator

GeneratorByName get a generator by name

type GeneratorOpts

type GeneratorOpts struct {
	SinkPath string
	Cleanup  bool
}

GeneratorOpts used for initial generator

type IfaceDescriptor

type IfaceDescriptor struct {
	Group      string
	Chain      string
	PkgName    string
	TypeName   string
	Comment    string // not support now so always empty
	Fields     []*FieldDescriptor
	EngineInfo *EngineInfo
}

IfaceDescriptor interface Descriptor info

func (*IfaceDescriptor) SetPkgName

func (d *IfaceDescriptor) SetPkgName(name string)

SetPkgName set package name

type IfaceDescriptors

type IfaceDescriptors map[string]*IfaceDescriptor

IfaceDescriptors interface Descriptor map {TypeName:*IfaceDescriptor}

type InitOpts

type InitOpts struct {
	RunMode           runMode
	GeneratorName     string
	ParserName        string
	SinkPath          string
	DefaultTag        string
	EnginePkgName     string
	EngineImportAlias string
	NoneQuery         bool
	Cleanup           bool
}

InitOpts use for generator or parser init

func InitFrom

func InitFrom(opts Options) *InitOpts

InitFrom initial from Options and return an InitOpts instance

func (*InitOpts) GeneratorOpts

func (opts *InitOpts) GeneratorOpts() *GeneratorOpts

GeneratorOpts return a GeneratorOpts

func (*InitOpts) ParserOpts

func (opts *InitOpts) ParserOpts() *ParserOpts

ParserOpts return a ParserOpts instance

type MirCtx

type MirCtx interface {
	context.Context
	Cancel(err error)
	ParserDone()
	GeneratorDone()
	Wait() error
	Capcity() int
	Pipe() (<-chan *IfaceDescriptor, chan<- *IfaceDescriptor)
}

MirCtx mir's concurrent parser/generator context

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option pass option to custom run behavior

func Cleanup

func Cleanup(enable bool) Option

Cleanup set generator cleanup out first when re-generate code

func DefaultTag

func DefaultTag(tag string) Option

DefaultTag set parser's default struct field tag string key

func EngineImportAlias

func EngineImportAlias(name string) Option

EngineImportAlias import package alias name

func EnginePkgName

func EnginePkgName(pkgName string) Option

EnginePkgName engine package name

func GeneratorName

func GeneratorName(name string) Option

GeneratorName set generator name option

func NoneQuery

func NoneQuery(enable bool) Option

NoneQuery set parser whether parse query

func ParserName

func ParserName(name string) Option

ParserName set parser name option

func RunMode

func RunMode(mode runMode) Option

RunMode set run mode option

func SinkPath

func SinkPath(path string) Option

SinkPath set generated code out directory

type Options

type Options []Option

Options generator options

func (Options) InitOpts

func (opts Options) InitOpts() *InitOpts

InitOpts return an initOpts instance

type Parser

type Parser interface {
	Name() string
	Init(opts *ParserOpts) error
	Parse(entries []interface{}) (Descriptors, error)
	ParseContext(ctx MirCtx, entries []interface{})
	Clone() Parser
}

Parser parse entries

func DefaultParser

func DefaultParser() Parser

DefaultParser get a default parser

func ParserByName

func ParserByName(name string) Parser

ParserByName get a parser by name

type ParserOpts

type ParserOpts struct {
	EngineInfo *EngineInfo
	DefaultTag string
	NoneQuery  bool
}

ParserOpts used for initial parser