tux

README

tux

Handmade and minimalistic Go web framework

Documentation

Index

• func GetTraceID(ctx context.Context) string
• func IsShutdown(err error) bool
• func NewShutdownError(msg string) error
• func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int) error
• func SetStatusCode(ctx context.Context, statusCode int) error
• type Circuit
• type Route
• type Tux
  • func New(shutdown chan os.Signal, ct ...Circuit) *Tux
  • func (t *Tux) AddRoute(verb string, group string, path string, route Route, ct ...Circuit)
  • func (t *Tux) Finish()
• type Values
  • func GetValues(ctx context.Context) (*Values, error)

Functions

func GetTraceID

func GetTraceID(ctx context.Context) string

func IsShutdown

func IsShutdown(err error) bool

func NewShutdownError

func NewShutdownError(msg string) error

func Respond

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

func SetStatusCode

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

Types

type Circuit

type Circuit func(Route) Route

Circuit is a function designed to run some code before and/or after another handler.

type Route

type Route func(context.Context, http.ResponseWriter, *http.Request) error

The Route type is an adapter to allow the use of our advanced functions as HTTP handlers.

type Tux

type Tux struct {
	*bunrouter.CompatRouter
	// contains filtered or unexported fields
}

func New

func New(shutdown chan os.Signal, ct ...Circuit) *Tux

New creates a Tux value that handle a set of routes for the application.

func (*Tux) AddRoute

func (t *Tux) AddRoute(verb string, group string, path string, route Route, ct ...Circuit)

AddRoute registers the route (handler) function for the given pattern.

func (*Tux) Finish

func (t *Tux) Finish()

Finish is used to gracefully shutdown our race when an integrity issue is identified.

type Values

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

func GetValues

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