meta

Documentation

Index

• Constants
• Variables
• type Backend
• type Manifest
  • func (manifest *Manifest) InitAndValidate(dir string) error
  • func (manifest *Manifest) Persist(dir string) error
  • func (manifest *Manifest) String() string
• type Mode

Constants

const (
	CmdUpdate = "update"
	CmdNew    = "new"
	CmdModel  = "model"
	CmdClient = "client"
)

hz Commands

const (
	IdlThrift = "thrift"
	IdlProto  = "proto"
)

hz IDLs

const (
	TpCompilerThrift = "thriftgo"
	TpCompilerProto  = "protoc"
)

Third-party Compilers

const (
	ProtocPluginName = "protoc-gen-hertz"
	ThriftPluginName = "thrift-gen-hertz"
)

hz Plugins

const (
	LoadError           = 1
	GenerateLayoutError = 2
	PersistError        = 3
	PluginError         = 4
)

hz Errors

const (
	ModelDir   = "biz/model"
	RouterDir  = "biz/router"
	HandlerDir = "biz/handler"
)

Package Dir

const AddThriftReplace = "do not generate 'go.mod', please add 'replace github.com/apache/thrift => github.com/apache/thrift v0.13.0' to your 'go.mod'"

const DefaultServiceName = "hertz_service"

const EnvPluginMode = "HERTZ_PLUGIN_MODE"

const ManifestFile = ".hz"

const (
	SetBodyParam = "setBodyParam(req).\n"
)

template const value

const SysType = runtime.GOOS

SysType is the running program's operating system type

const TheUseOptionMessage = "'model code' is not generated due to the '-use' option"

TheUseOptionMessage indicates that the generating of 'model code' is aborted due to the -use option for thrift IDL.

const Version = "v0.8.1"

Version hz version

const WindowsOS = "windows"

Variables

var GoVersion *gv.Version

Types

type Backend

type Backend string

Backend Model Backends

const (
	BackendGolang Backend = "golang"
)

type Manifest

type Manifest struct {
	Version    string `yaml:"hz version"`
	HandlerDir string `yaml:"handlerDir"`
	ModelDir   string `yaml:"modelDir"`
	RouterDir  string `yaml:"routerDir"`
}

func (*Manifest) InitAndValidate

func (manifest *Manifest) InitAndValidate(dir string) error

func (*Manifest) Persist

func (manifest *Manifest) Persist(dir string) error

func (*Manifest) String

func (manifest *Manifest) String() string

type Mode

type Mode int

Mode hz run modes