kurin

README

Kurin

Very little helper with an example to create simple and clean Go app. Mostly for own usage, but maybe can inspire you how to structure your own go app.

Strongly inspired by CaptaionCodeman's project, so please check his project for more details about this structure.

Documentation

Index

• type Adapter
• type App
  • func NewApp(name string, adapters ...Adapter) *App
  • func (a *App) RegisterSystems(systems ...interface{})
  • func (a *App) Run()
  • func (a *App) SetLogger(logger Logger)
• type Closable
• type Fallible
• type Logger

Types

type Adapter

type Adapter interface {
	Closable
	Open()
	OnFailure(error)
}

type App

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

func NewApp

func NewApp(name string, adapters ...Adapter) *App

func (*App) RegisterSystems

func (a *App) RegisterSystems(systems ...interface{})

func (*App) Run

func (a *App) Run()

func (*App) SetLogger

func (a *App) SetLogger(logger Logger)

type Closable

type Closable interface {
	Close()
}

type Fallible

type Fallible interface {
	NotifyFail(chan error)
}

type Logger

type Logger interface {
	Debug(args ...interface{})
	Info(args ...interface{})
	Warn(args ...interface{})
	Error(args ...interface{})
	Fatal(args ...interface{})
	Panic(args ...interface{})
}