lime

package module
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 28, 2023 License: MIT Imports: 16 Imported by: 1

README

lime

lime is the garnish for your Gin Gonic project.

Documentation

Index

Constants

View Source
const (
	DebugLevel = LogLevel(zerolog.DebugLevel)
	InfoLevel  = LogLevel(zerolog.InfoLevel)
	WarnLevel  = LogLevel(zerolog.WarnLevel)
	ErrorLevel = LogLevel(zerolog.ErrorLevel)
	FatalLevel = LogLevel(zerolog.FatalLevel)
	PanicLevel = LogLevel(zerolog.PanicLevel)
	NoLevel    = LogLevel(zerolog.NoLevel)
	Disabled   = LogLevel(zerolog.Disabled)
	TraceLevel = LogLevel(zerolog.TraceLevel)
)

Variables

This section is empty.

Functions

func AssertPanic added in v0.4.0

func AssertPanic(t *testing.T, f func())

func DatabaseProvider

func DatabaseProvider(models DatabaseModels, config *DatabaseConfiguration) *gorm.DB

Types

type Application

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

func (*Application) IsRunning added in v0.4.0

func (app *Application) IsRunning() bool

func (*Application) Start

func (app *Application) Start() error

func (*Application) Stop added in v0.4.0

func (app *Application) Stop()

type ApplicationConfiguration added in v0.6.0

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

func ApplicationWith added in v0.6.0

func ApplicationWith() *ApplicationConfiguration

func (*ApplicationConfiguration) Configure added in v0.6.0

func (c *ApplicationConfiguration) Configure() *Application

func (*ApplicationConfiguration) CorsAllowCredentials added in v0.10.0

func (c *ApplicationConfiguration) CorsAllowCredentials(allowCredentials bool) *ApplicationConfiguration

func (*ApplicationConfiguration) CorsAllowHeaders added in v0.10.0

func (c *ApplicationConfiguration) CorsAllowHeaders(allowHeaders []string) *ApplicationConfiguration

func (*ApplicationConfiguration) CorsAllowMethods added in v0.10.0

func (c *ApplicationConfiguration) CorsAllowMethods(allowMethods []string) *ApplicationConfiguration

func (*ApplicationConfiguration) CorsAllowOrigins added in v0.10.0

func (c *ApplicationConfiguration) CorsAllowOrigins(allowOrigins []string) *ApplicationConfiguration

func (*ApplicationConfiguration) Database added in v0.6.0

func (*ApplicationConfiguration) Logging added in v0.6.0

func (*ApplicationConfiguration) Model added in v0.7.0

func (*ApplicationConfiguration) Models added in v0.6.0

func (*ApplicationConfiguration) Port added in v0.8.0

func (*ApplicationConfiguration) Router added in v0.6.0

type AtomicBool added in v0.4.0

type AtomicBool int32

type CorsConfiguration added in v0.3.0

type CorsConfiguration struct {
	AllowOrigins     []string
	AllowMethods     []string
	AllowHeaders     []string
	AllowCredentials bool
}

func DefaultCorsConfiguration added in v0.10.0

func DefaultCorsConfiguration() *CorsConfiguration

type DatabaseConfiguration

type DatabaseConfiguration struct {
	DSN        string
	Connect    connect
	GormConfig *gorm.Config
}

type DatabaseModel added in v0.7.0

type DatabaseModel interface{}

type DatabaseModels added in v0.6.0

type DatabaseModels []DatabaseModel

type DatabaseStarter

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

func (*DatabaseStarter) Start

func (ds *DatabaseStarter) Start() *gorm.DB

type LogConfiguration added in v0.3.0

type LogConfiguration struct {
	GlobalLevel LogLevel
}

type LogLevel added in v0.3.0

type LogLevel zerolog.Level

func LogLevelBy added in v0.8.0

func LogLevelBy(level string) LogLevel

func (LogLevel) Level added in v0.7.2

func (l LogLevel) Level() zerolog.Level

type Logger added in v0.4.0

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

func NewLogger added in v0.4.0

func NewLogger(name string) *Logger

func (*Logger) Debug added in v0.4.0

func (l *Logger) Debug() *zerolog.Event

func (*Logger) Error added in v0.4.0

func (l *Logger) Error() *zerolog.Event

func (*Logger) Fatal added in v0.4.0

func (l *Logger) Fatal() *zerolog.Event

func (*Logger) Info added in v0.4.0

func (l *Logger) Info() *zerolog.Event

func (*Logger) Warn added in v0.4.0

func (l *Logger) Warn() *zerolog.Event

func (*Logger) WithLevel added in v0.7.2

func (l *Logger) WithLevel(level LogLevel) *zerolog.Event

type RequestLogWriter added in v0.7.2

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

func DebugRequestWriter added in v0.7.2

func DebugRequestWriter(logger *Logger) *RequestLogWriter

func (RequestLogWriter) Write added in v0.7.2

func (w RequestLogWriter) Write(p []byte) (n int, err error)

type RoutedController

type RoutedController interface {
	Register(engine *gin.Engine)
}

type Router

type Router struct {
	Routes []RoutedController
}

func (*Router) RegisterRoutes

func (r *Router) RegisterRoutes(engine *gin.Engine)

type RouterFactory added in v0.4.0

type RouterFactory func(runtime *RuntimeContext) *Router

type RuntimeContext added in v0.4.0

type RuntimeContext struct {
	Engine   *gin.Engine
	Server   *http.Server
	Database *gorm.DB
}

type TestAfterStart added in v0.4.0

type TestAfterStart func(t *testing.T)

type TestConfiguration added in v0.7.0

type TestConfiguration struct {
	ApplicationConfiguration
}

func TestContextWith added in v0.6.0

func TestContextWith() *TestConfiguration

func (*TestConfiguration) Configure added in v0.7.0

func (c *TestConfiguration) Configure() *TestContext

func (*TestConfiguration) CorsAllowCredentials added in v0.10.0

func (c *TestConfiguration) CorsAllowCredentials(allowCredentials bool) *TestConfiguration

func (*TestConfiguration) CorsAllowHeaders added in v0.10.0

func (c *TestConfiguration) CorsAllowHeaders(allowHeaders []string) *TestConfiguration

func (*TestConfiguration) CorsAllowMethods added in v0.10.0

func (c *TestConfiguration) CorsAllowMethods(allowMethods []string) *TestConfiguration

func (*TestConfiguration) CorsAllowOrigins added in v0.10.0

func (c *TestConfiguration) CorsAllowOrigins(allowOrigins []string) *TestConfiguration

func (*TestConfiguration) Database added in v0.7.0

func (c *TestConfiguration) Database(databaseConfig *DatabaseConfiguration) *TestConfiguration

func (*TestConfiguration) Logging added in v0.7.0

func (c *TestConfiguration) Logging(logConfiguration *LogConfiguration) *TestConfiguration

func (*TestConfiguration) Model added in v0.7.0

func (*TestConfiguration) Models added in v0.7.0

func (c *TestConfiguration) Models(models []DatabaseModel) *TestConfiguration

func (*TestConfiguration) Port added in v0.8.0

func (c *TestConfiguration) Port(port int) *TestConfiguration

func (*TestConfiguration) Router added in v0.7.0

func (c *TestConfiguration) Router(routerFactory RouterFactory) *TestConfiguration

type TestContext

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

func (*TestContext) CreateEntity

func (ctx *TestContext) CreateEntity(value interface{}) error

func (*TestContext) DELETE added in v0.7.0

func (ctx *TestContext) DELETE(uri string) *httptest.ResponseRecorder

func (*TestContext) GET added in v0.7.0

func (*TestContext) POST added in v0.7.0

func (ctx *TestContext) POST(uri string, body interface{}) *httptest.ResponseRecorder

func (*TestContext) PUT added in v0.7.0

func (ctx *TestContext) PUT(uri string, body interface{}) *httptest.ResponseRecorder

func (*TestContext) Perform

func (ctx *TestContext) Perform(req *http.Request) *httptest.ResponseRecorder

func (*TestContext) RunTest added in v0.4.0

func (ctx *TestContext) RunTest(t *testing.T, postStartCall TestAfterStart)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL