toybox

README

toybox

a scaffolding project

示例

example

---

go get -u github.com/inoth/toybox@latest

go install github.com/inoth/toybox/cmd/toybox@latest

toybox new helloworld

cd helloworld

Documentation

Index

• Variables
• type Option
  • func WithConfig(cfg config.ConfigMate) Option
  • func WithContext(ctx context.Context) Option
  • func WithName(name string) Option
  • func WithServer(svcs ...transport.Transport) Option
  • func WithVersion(version string) Option
  • func WithWatch() Option
• type ToyBox
  • func New(opts ...Option) *ToyBox
  • func (tb *ToyBox) ID() string
  • func (tb *ToyBox) Name() string
  • func (tb *ToyBox) Run() (err error)
  • func (tb *ToyBox) Stop() error
  • func (tb *ToyBox) Version() string

Variables

var (
	ErrNotConfig = errors.New("unable to load configuration")
	ErrRestart   = errors.New("restart")
)

Types

type Option

type Option func(opt *option)

func WithConfig

func WithConfig(cfg config.ConfigMate) Option

func WithContext

func WithContext(ctx context.Context) Option

func WithName

func WithName(name string) Option

func WithServer

func WithServer(svcs ...transport.Transport) Option

func WithVersion

func WithVersion(version string) Option

func WithWatch

func WithWatch() Option

type ToyBox

type ToyBox struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *ToyBox

func (*ToyBox) ID

func (tb *ToyBox) ID() string

func (*ToyBox) Name

func (tb *ToyBox) Name() string

func (*ToyBox) Run

func (tb *ToyBox) Run() (err error)

func (*ToyBox) Stop

func (tb *ToyBox) Stop() error

func (*ToyBox) Version

func (tb *ToyBox) Version() string