server

package

Go to main page

Versions in this module

v1

v1.16.0

Sep 1, 2025

Changes in this version

type Identity

+ Data map[string]any

v1.15.9

Aug 30, 2025

v1.15.0

Jul 12, 2025

Changes in this version

+ var HandlerName = "handler_name"

v1.14.8

Jun 17, 2025

v1.14.7

Jun 16, 2025

v1.14.6

Jun 11, 2025

v1.14.5

Jun 7, 2025

v1.14.4

Jun 7, 2025

v1.14.3

May 24, 2025

v1.14.2

May 20, 2025

v1.14.1

May 20, 2025

v1.14.0

May 20, 2025

Changes in this version

type Request

+ func (req *Request) Error(err error) *errors.Error

v1.13.0

May 20, 2025

Changes in this version

type Identity

+ ID string

+ Permissions []string

+ Role string

v1.12.2

May 18, 2025

v1.12.1

May 17, 2025

v1.12.0

May 17, 2025

Changes in this version

+ type ErrorHandler func(c context.Context, rctx *app.RequestContext, err error)

v1.11.2

May 16, 2025

v1.11.1

May 7, 2025

v1.11.0

May 7, 2025

v1.10.0

Jan 29, 2025

v1.9.0

Jan 29, 2025

v1.8.0

Jan 29, 2025

Changes in this version

+ func SetErrorHandler(f func(*app.RequestContext, error))

+ type ErrorHandlerFn func(*app.RequestContext, error)

+ type RequestDto interface

+ Validate func(ctx context.Context) error

v1.7.0

Jan 28, 2025

v1.6.0

Oct 21, 2024

Changes in this version

type Request

+ func (req *Request) Method() string

v1.5.0

Oct 8, 2024

Changes in this version

+ func Register[IN any, OUT any](action func(context.Context, *Request, IN) (OUT, error))

type Handler

+ HandlerFn func(context.Context, *Request, IN) (OUT, error)

v1.4.1

Jun 16, 2024

v1.4.0

Jun 16, 2024

v1.3.2

Jun 13, 2024

v1.3.1

Jun 13, 2024

v1.3.0

Jun 11, 2024

v1.2.1

Jun 10, 2024

v1.2.0

Jun 4, 2024

Changes in this version

+ func AddDecorator(name string, f decoratorFn)

v1.1.0

Jun 4, 2024

Changes in this version

type Request

+ func (req *Request) Abort()

+ func (req *Request) AbortWithError(code int, err error) *errors.Error

+ func (req *Request) AbortWithMsg(msg string, statusCode int)

+ func (req *Request) AbortWithStatus(code int)

+ func (req *Request) AbortWithStatusJSON(code int, jsonObj any)

+ func (req *Request) ClientIP() string

+ func (req *Request) ContentType() []byte

+ func (req *Request) Cookie(key string) []byte

+ func (req *Request) ForEachKey(f func(key string, v any))

+ func (req *Request) FullPath() string

+ func (req *Request) GetHeader(key string) []byte

+ func (req *Request) Host() []byte

+ func (req *Request) Identity() Identity

+ func (req *Request) IfModifiedSince(lastModified time.Time) bool

+ func (req *Request) IsEnableTrace() bool

+ func (req *Request) Next(c context.Context)

+ func (req *Request) Path() []byte

+ func (req *Request) RemoteAddr() net.Addr

+ func (req *Request) RequestBodyStream() io.Reader

+ func (req *Request) SaveUploadedFile(file *multipart.FileHeader, dst string) error

+ func (req *Request) Set(key string, value any)

+ func (req *Request) SetCookie(name, value string, maxAge int, path, domain string, ...)

+ func (req *Request) SetEnableTrace(enable bool)

+ func (req *Request) SetHeader(key, value string)

+ func (req *Request) SetIdentity(identity Identity)

+ func (req *Request) URI() *protocol.URI

+ func (req *Request) UserAgent() []byte

+ func (req *Request) Value(key any) any

v1.0.0

Jun 4, 2024

Changes in this version

+ func SetIdentifier(identifierFn identifierFn)

type Context

+ func (ctx *Context) GetHeader(key string) []byte

v0

v0.1.3

May 14, 2024

v0.1.2

May 8, 2024

v0.1.1

May 7, 2024

Changes in this version

type Context

+ func (ctx *Context) AbortWithMsg(msg string, code int)

+ type Empty struct

+ func (e *Empty) Validate(*Context) error

+ type Request interface

+ type Validator interface

+ Validate func(ctx *Context) error

v0.1.0

May 7, 2024

Changes in this version

+ func Handle[IN any, OUT any](handlers ...func(*Context, IN) (OUT, error))

+ func Hertz(devMode bool, opts ...config.Option) *server.Hertz

+ func NoMethod(handlers ...app.HandlerFunc)

+ func NoRoute(handlers ...app.HandlerFunc)

+ func Static(relativePath, root string)

+ func StaticFile(relativePath, filepath string)

+ func Use(handlers ...app.HandlerFunc)

+ func WithALPN(enable bool) config.Option

+ func WithAltTransport(transporter func(options *config.Options) network.Transporter) config.Option

+ func WithAutoReloadRender(b bool, interval time.Duration) config.Option

+ func WithBasePath(basePath string) config.Option

+ func WithBindConfig(bc *binding.BindConfig) config.Option

+ func WithCustomBinder(b binding.Binder) config.Option

+ func WithCustomValidator(b binding.StructValidator) config.Option

+ func WithDisableDefaultContentType(disable bool) config.Option

+ func WithDisableDefaultDate(disable bool) config.Option

+ func WithDisableHeaderNamesNormalizing(disable bool) config.Option

+ func WithDisablePreParseMultipartForm(b bool) config.Option

+ func WithDisablePrintRoute(b bool) config.Option

+ func WithExitWaitTime(timeout time.Duration) config.Option

+ func WithGetOnly(isOnly bool) config.Option

+ func WithH2C(enable bool) config.Option

+ func WithHandleMethodNotAllowed(b bool) config.Option

+ func WithHostPorts(hp string) config.Option

+ func WithIdleTimeout(t time.Duration) config.Option

+ func WithKeepAlive(b bool) config.Option

+ func WithKeepAliveTimeout(t time.Duration) config.Option

+ func WithListenConfig(l *net.ListenConfig) config.Option

+ func WithMaxKeepBodySize(bs int) config.Option

+ func WithMaxRequestBodySize(bs int) config.Option

+ func WithNetwork(nw string) config.Option

+ func WithOnAccept(fn func(conn net.Conn) context.Context) config.Option

+ func WithOnConnect(fn func(ctx context.Context, conn network.Conn) context.Context) config.Option

+ func WithReadBufferSize(size int) config.Option

+ func WithReadTimeout(t time.Duration) config.Option

+ func WithRedirectFixedPath(b bool) config.Option

+ func WithRedirectTrailingSlash(b bool) config.Option

+ func WithRegistry(r registry.Registry, info *registry.Info) config.Option

+ func WithRemoveExtraSlash(b bool) config.Option

+ func WithStreamBody(b bool) config.Option

+ func WithTLS(cfg *tls.Config) config.Option

+ func WithTraceLevel(level stats.Level) config.Option

+ func WithTracer(t tracer.Tracer) config.Option

+ func WithTransport(transporter func(options *config.Options) network.Transporter) config.Option

+ func WithUnescapePathValues(b bool) config.Option

+ func WithUseRawPath(b bool) config.Option

+ func WithValidateConfig(vc *binding.ValidateConfig) config.Option

+ func WithWriteTimeout(t time.Duration) config.Option

+ type Context struct

+ func (ctx *Context) ClientIP() string

+ func (ctx *Context) ContentType() []byte

+ func (ctx *Context) Cookie(key string) []byte

+ func (ctx *Context) ForEachKey(f func(key string, v any))

+ func (ctx *Context) FullPath() string

+ func (ctx *Context) Host() []byte

+ func (ctx *Context) Identity() Identity

+ func (ctx *Context) IfModifiedSince(lastModified time.Time) bool

+ func (ctx *Context) IsEnableTrace() bool

+ func (ctx *Context) Path() []byte

+ func (ctx *Context) RemoteAddr() net.Addr

+ func (ctx *Context) RequestBodyStream() io.Reader

+ func (ctx *Context) SaveUploadedFile(file *multipart.FileHeader, dst string) error

+ func (ctx *Context) Set(key string, value any)

+ func (ctx *Context) SetCookie(name, value string, maxAge int, path, domain string, ...)

+ func (ctx *Context) SetEnableTrace(enable bool)

+ func (ctx *Context) SetHeader(key, value string)

+ func (ctx *Context) SetIdentity(identity Identity)

+ func (ctx *Context) URI() *protocol.URI

+ func (ctx *Context) UserAgent() []byte

+ func (ctx *Context) Value(key any) any

+ type Handler struct

+ Action func(*Context, IN) (OUT, error)

+ RespondFn func(ctx *app.RequestContext, response any)

+ type Identity map[string]any

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