swe

Documentation

Index

• Variables
• func AssignLogID(ctx *Context)
• func CtxLogID(ctx *Context) string
• func CtxValue[T any](ctx *Context, key any) (ret T, ok bool)
• func DecodeForm(r *http.Request, ptr any) error
• func InitLogID(ctx *Context)
• func RenderTime(ts time.Time) string
• func SetDefaultLogLevel(level LogLevel)
• func SetDefaultLogRenderer(r LogRenderer)
• func SetDefaultLogWriter(out io.Writer)
• type APIServer
  • func NewAPIServer() *APIServer
  • func (s *APIServer) RegisterHandler(method, path string, handler HandlerFunc, middlewares ...HandlerFunc)
  • func (s *APIServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Context
  • func (ctx *Context) Get(key any) (any, bool)
  • func (ctx *Context) Next()
  • func (ctx *Context) Put(key, value any)
• type Engine
  • func NewEngine(apiPrefix string, apiServer *APIServer, fileServer *FileServer) *Engine
  • func (s *Engine) Close() error
  • func (s *Engine) Serve(addr string)
  • func (s *Engine) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type FileServer
  • func NewFileServer(root, tryFile string, forbidDir bool) *FileServer
  • func (s *FileServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandlerFunc
  • func MakeAPIHandler[InType, OutType any](handler func(*Context, *InType) (*OutType, SweError)) HandlerFunc
• type LogLevel
  • func (l LogLevel) String() string
• type LogRenderer
• type Logger
  • func CtxLogger(ctx *Context) *Logger
  • func (l *Logger) Debug(format string, params ...any)
  • func (l *Logger) Error(format string, params ...any)
  • func (l *Logger) Info(format string, params ...any)
  • func (l *Logger) SetLevel(level LogLevel)
  • func (l *Logger) SetRenderer(r LogRenderer)
  • func (l *Logger) SetWriter(out io.Writer)
  • func (l *Logger) Warn(format string, params ...any)
• type SweError
  • func Error(code int, err error) SweError
• type Validator

Variables

var CtxKeyLogID string = "ctx_logid"

Functions

func AssignLogID

func AssignLogID(ctx *Context)

func CtxLogID

func CtxLogID(ctx *Context) string

func CtxValue

func CtxValue[T any](ctx *Context, key any) (ret T, ok bool)

func DecodeForm

func DecodeForm(r *http.Request, ptr any) error

func InitLogID

func InitLogID(ctx *Context)

func RenderTime

func RenderTime(ts time.Time) string

func SetDefaultLogLevel

func SetDefaultLogLevel(level LogLevel)

func SetDefaultLogRenderer

func SetDefaultLogRenderer(r LogRenderer)

func SetDefaultLogWriter

func SetDefaultLogWriter(out io.Writer)

Types

type APIServer

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

func NewAPIServer

func NewAPIServer() *APIServer

func (*APIServer) RegisterHandler

func (s *APIServer) RegisterHandler(method, path string, handler HandlerFunc, middlewares ...HandlerFunc)

func (*APIServer) ServeHTTP

func (s *APIServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Context

type Context struct {
	Request  *http.Request
	Response http.ResponseWriter
	// contains filtered or unexported fields
}

func (*Context) Get

func (ctx *Context) Get(key any) (any, bool)

func (*Context) Next

func (ctx *Context) Next()

func (*Context) Put

func (ctx *Context) Put(key, value any)

type Engine

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

func NewEngine

func NewEngine(apiPrefix string, apiServer *APIServer, fileServer *FileServer) *Engine

func (*Engine) Close

func (s *Engine) Close() error

func (*Engine) Serve

func (s *Engine) Serve(addr string)

func (*Engine) ServeHTTP

func (s *Engine) ServeHTTP(w http.ResponseWriter, r *http.Request)

type FileServer

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

func NewFileServer

func NewFileServer(root, tryFile string, forbidDir bool) *FileServer

func (*FileServer) ServeHTTP

func (s *FileServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type HandlerFunc

type HandlerFunc func(*Context)

func MakeAPIHandler

func MakeAPIHandler[InType, OutType any](handler func(*Context, *InType) (*OutType, SweError)) HandlerFunc

type LogLevel

type LogLevel int

const (
	LOG_DEBUG LogLevel = iota
	LOG_INFO
	LOG_WARN
	LOG_ERROR
)

func (LogLevel) String

func (l LogLevel) String() string

type LogRenderer

type LogRenderer interface {
	RenderLog(ctx *Context, level LogLevel, ts time.Time, file string, line int, content string) string
}

type Logger

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

func CtxLogger

func CtxLogger(ctx *Context) *Logger

func (*Logger) Debug

func (l *Logger) Debug(format string, params ...any)

func (*Logger) Error

func (l *Logger) Error(format string, params ...any)

func (*Logger) Info

func (l *Logger) Info(format string, params ...any)

func (*Logger) SetLevel

func (l *Logger) SetLevel(level LogLevel)

func (*Logger) SetRenderer

func (l *Logger) SetRenderer(r LogRenderer)

func (*Logger) SetWriter

func (l *Logger) SetWriter(out io.Writer)

func (*Logger) Warn

func (l *Logger) Warn(format string, params ...any)

type SweError

type SweError interface {
	Err() error
	Code() int
}

func Error

func Error(code int, err error) SweError

type Validator

type Validator interface {
	Validate(ctx *Context) error
}