core

Documentation

Index

• func Check(e error, isFatal bool)
• func GetEnv(key string, fallback interface{}) interface{}
• func NewRouter(mountPoints []Mountable, log *Logger) *router.Router
• type Cache
  • func NewCache(config *Configuration) *Cache
  • func (c *Cache) Get(key string, expiration time.Duration, cache CacheMethod) (interface{}, error)
• type CacheMethod
• type Configuration
  • func NewConfiguration(namespace string, overrides map[string]interface{}) *Configuration
• type Logger
  • func NewLogger() *Logger
• type Mountable
• type QueryLogger
  • func (ql QueryLogger) AfterQuery(c context.Context, q *bun.QueryEvent)
  • func (ql QueryLogger) BeforeQuery(c context.Context, q *bun.QueryEvent) context.Context
• type Server
  • func NewServer(name string, routes []Mountable, config *Configuration, log *Logger) *Server
  • func (srv *Server) Run()

Functions

func Check

func Check(e error, isFatal bool)

Check checks multiple err != nil mantras & logs if something went wrong

func GetEnv

func GetEnv(key string, fallback interface{}) interface{}

GetEnv returns ENV variable value or fallback if not set

func NewRouter

func NewRouter(mountPoints []Mountable, log *Logger) *router.Router

NewRouter creates root loader and mounts subrouters

Types

type Cache

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

func NewCache

func NewCache(config *Configuration) *Cache

func (*Cache) Get

func (c *Cache) Get(key string, expiration time.Duration, cache CacheMethod) (interface{}, error)

GetCached returns cached result of a func

type CacheMethod

type CacheMethod func() (interface{}, error)

CacheMethod generic cacheable function

type Configuration

type Configuration struct {
	BaseURL           string
	Debug             bool
	HostAddress       string
	Port              int
	TemplatePath      string
	MediaPath         string
	MediaURL          string
	ThumbnailsPrefix  string
	CacheEnabled      bool
	DbHost            string
	DbPort            string
	DbName            string
	DbUser            string
	DbPassword        string
	SMTPHost          string
	SMTPPort          int
	SMTPUser          string
	SMTPPassword      string
	SessionVersion    string
	SecureAuthKey     string
	SecureVault       *securecookie.SecureCookie
	SecondsRarely     time.Duration
	SecondsFrequently time.Duration
	Timezone          *time.Location
}

func NewConfiguration

func NewConfiguration(namespace string, overrides map[string]interface{}) *Configuration

NewConfiguration sets Config singletone by ENV variables overriden by map

type Logger

type Logger struct {
	logrus.Logger
}

func NewLogger

func NewLogger() *Logger

InitLogger sets debug level and logger preferences

type Mountable

type Mountable interface {
	Mount(*router.Router)
}

Mountable describes a routing group to be attached in the main pnk

type QueryLogger

type QueryLogger struct{}

QueryLogger logs formatted queries

func (QueryLogger) AfterQuery

func (ql QueryLogger) AfterQuery(c context.Context, q *bun.QueryEvent)

AfterQuery logs formatted query after it finishes

func (QueryLogger) BeforeQuery

func (ql QueryLogger) BeforeQuery(c context.Context, q *bun.QueryEvent) context.Context

BeforeQuery dummy

type Server

type Server struct {
	fasthttp.Server
	// contains filtered or unexported fields
}

func NewServer

func NewServer(name string, routes []Mountable, config *Configuration, log *Logger) *Server

func (*Server) Run

func (srv *Server) Run()