web

Documentation

Index

• func GetTraceID(ctx context.Context) string
• func IsShutdown(e error) bool
• func NewShutdownError(message string) error
• func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int) error
• func SetStatusCode(ctx context.Context, statusCode int) error
• type App
  • func NewApp(shutdown chan os.Signal, mw ...Middleware) *App
  • func (a *App) Handle(method, group, path string, handler Handler, mw ...Middleware)
  • func (a *App) SignalShutdown()
• type Handler
• type Middleware
• type Values
  • func GetValues(ctx context.Context) (*Values, error)

Functions

func GetTraceID

func GetTraceID(ctx context.Context) string

func IsShutdown

func IsShutdown(e error) bool

func NewShutdownError

func NewShutdownError(message string) error

NewShutdownError causes to signal a graceful shutdown

func Respond

func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int) error

Respond converts a Go value to JSON and sends it to the client.

func SetStatusCode

func SetStatusCode(ctx context.Context, statusCode int) error

Types

type App

type App struct {
	*httptreemux.ContextMux
	// contains filtered or unexported fields
}

func NewApp

func NewApp(shutdown chan os.Signal, mw ...Middleware) *App

func (*App) Handle

func (a *App) Handle(method, group, path string, handler Handler, mw ...Middleware)

func (*App) SignalShutdown

func (a *App) SignalShutdown()

type Handler

type Handler func(ctx context.Context, w http.ResponseWriter, r *http.Request) error

type Middleware

type Middleware func(Handler) Handler

type Values

type Values struct {
	TraceID    string
	Now        time.Time
	StatusCode int
}

func GetValues

func GetValues(ctx context.Context) (*Values, error)