gear

Dec 23, 2021

Changes in this version

+ const HeaderXCanary

+ const HeaderXForwardedHost

+ const HeaderXForwardedScheme

+ const HeaderXForwardedServer

+ const HeaderXRealScheme

+ const HeaderXRequestID

+ const MIMEApplicationSchemaGraphQL

+ const MIMEApplicationSchemaInstanceJSON

+ const MIMEApplicationSchemaJSON

+ const MIMEApplicationSchemaJSONLD

+ const MIMEApplicationTOML

+ const MIMEApplicationYAML

+ const SetGraceTimeout

+ const SetParseError

+ const SetRenderError

+ const SetSender

+ const SetServerName

+ const SetTrustedProxy

+ const SetURLParser

+ var Err = &Error

+ var ErrBadGateway = Err.WithCode(http.StatusBadGateway).WithErr("BadGateway")

+ var ErrBadRequest = Err.WithCode(http.StatusBadRequest).WithErr("BadRequest")

+ var ErrClientClosedRequest = Err.WithCode(499).WithErr("ClientClosedRequest")

+ var ErrConflict = Err.WithCode(http.StatusConflict).WithErr("Conflict")

+ var ErrExpectationFailed = Err.WithCode(http.StatusExpectationFailed).WithErr("ExpectationFailed")

+ var ErrFailedDependency = Err.WithCode(http.StatusFailedDependency).WithErr("FailedDependency")

+ var ErrForbidden = Err.WithCode(http.StatusForbidden).WithErr("Forbidden")

+ var ErrGatewayTimeout = Err.WithCode(http.StatusGatewayTimeout).WithErr("GatewayTimeout")

+ var ErrGone = Err.WithCode(http.StatusGone).WithErr("Gone")

+ var ErrHTTPVersionNotSupported = Err.WithCode(http.StatusHTTPVersionNotSupported).WithErr("HTTPVersionNotSupported")

+ var ErrInsufficientStorage = Err.WithCode(http.StatusInsufficientStorage).WithErr("InsufficientStorage")

+ var ErrInternalServerError = Err.WithCode(http.StatusInternalServerError).WithErr("InternalServerError")

+ var ErrLengthRequired = Err.WithCode(http.StatusLengthRequired).WithErr("LengthRequired")

+ var ErrLocked = Err.WithCode(http.StatusLocked).WithErr("Locked")

+ var ErrLoopDetected = Err.WithCode(http.StatusLoopDetected).WithErr("LoopDetected")

+ var ErrMethodNotAllowed = Err.WithCode(http.StatusMethodNotAllowed).WithErr("MethodNotAllowed")

+ var ErrMisdirectedRequest = Err.WithCode(421).WithErr("MisdirectedRequest")

+ var ErrNetworkAuthenticationRequired = Err.WithCode(http.StatusNetworkAuthenticationRequired).WithErr("NetworkAuthenticationRequired")

+ var ErrNotAcceptable = Err.WithCode(http.StatusNotAcceptable).WithErr("NotAcceptable")

+ var ErrNotExtended = Err.WithCode(http.StatusNotExtended).WithErr("NotExtended")

+ var ErrNotFound = Err.WithCode(http.StatusNotFound).WithErr("NotFound")

+ var ErrNotImplemented = Err.WithCode(http.StatusNotImplemented).WithErr("NotImplemented")

+ var ErrPaymentRequired = Err.WithCode(http.StatusPaymentRequired).WithErr("PaymentRequired")

+ var ErrPreconditionFailed = Err.WithCode(http.StatusPreconditionFailed).WithErr("PreconditionFailed")

+ var ErrPreconditionRequired = Err.WithCode(http.StatusPreconditionRequired).WithErr("PreconditionRequired")

+ var ErrProxyAuthRequired = Err.WithCode(http.StatusProxyAuthRequired).WithErr("ProxyAuthenticationRequired")

+ var ErrRequestEntityTooLarge = Err.WithCode(http.StatusRequestEntityTooLarge).WithErr("RequestEntityTooLarge")

+ var ErrRequestHeaderFieldsTooLarge = Err.WithCode(http.StatusRequestHeaderFieldsTooLarge).WithErr("RequestHeaderFieldsTooLarge")

+ var ErrRequestTimeout = Err.WithCode(http.StatusRequestTimeout).WithErr("RequestTimeout")

+ var ErrRequestURITooLong = Err.WithCode(http.StatusRequestURITooLong).WithErr("RequestURITooLong")

+ var ErrRequestedRangeNotSatisfiable = Err.WithCode(http.StatusRequestedRangeNotSatisfiable).WithErr("RequestedRangeNotSatisfiable")

+ var ErrServiceUnavailable = Err.WithCode(http.StatusServiceUnavailable).WithErr("ServiceUnavailable")

+ var ErrTeapot = Err.WithCode(http.StatusTeapot).WithErr("Teapot")

+ var ErrTooManyRequests = Err.WithCode(http.StatusTooManyRequests).WithErr("TooManyRequests")

+ var ErrUnauthorized = Err.WithCode(http.StatusUnauthorized).WithErr("Unauthorized")

+ var ErrUnavailableForLegalReasons = Err.WithCode(http.StatusUnavailableForLegalReasons).WithErr("UnavailableForLegalReasons")

+ var ErrUnprocessableEntity = Err.WithCode(http.StatusUnprocessableEntity).WithErr("UnprocessableEntity")

+ var ErrUnsupportedMediaType = Err.WithCode(http.StatusUnsupportedMediaType).WithErr("UnsupportedMediaType")

+ var ErrUpgradeRequired = Err.WithCode(http.StatusUpgradeRequired).WithErr("UpgradeRequired")

+ var ErrVariantAlsoNegotiates = Err.WithCode(http.StatusVariantAlsoNegotiates).WithErr("VariantAlsoNegotiates")

+ func ContextWithSignal(ctx context.Context) context.Context

+ func Decompress(encoding string, r io.Reader) (io.ReadCloser, error)

+ func GetRouterNodeFromCtx(ctx *Context) *trie.Node

+ func GetRouterPatternFromCtx(ctx *Context) string

+ func RenderErrorResponse(err HTTPError) (int, string, []byte)

+ func ValuesToStruct(values map[string][]string, target interface{}, tag string) (err error)

type App

+ func (app *App) ListenWithContext(ctx context.Context, addr string, keyPair ...string) error

+ func (app *App) ServeWithContext(ctx context.Context, l net.Listener, keyPair ...string) error

type Context

+ StartAt time.Time

+ func (ctx *Context) GetHeader(key string) string

+ func (ctx *Context) GetHeaders(key string) []string

+ func (ctx *Context) LogErr(err error)

+ func (ctx *Context) MustAny(any interface{}) interface{}

+ func (ctx *Context) OkHTML(str string) error

+ func (ctx *Context) OkJSON(val interface{}) error

+ func (ctx *Context) OkRender(name string, val interface{}) error

+ func (ctx *Context) OkSend(val interface{}) error

+ func (ctx *Context) OkStream(contentType string, r io.Reader) error

+ func (ctx *Context) OkXML(val interface{}) error

+ func (ctx *Context) ParseURL(body BodyTemplate) error

+ func (ctx *Context) Protocol(trustedProxy ...bool) string

+ func (ctx *Context) Scheme(trustedProxy ...bool) string

+ func (ctx *Context) Send(code int, data interface{}) (err error)

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

+ type DefaultURLParser struct

+ func (d DefaultURLParser) Parse(val map[string][]string, body interface{}, tag string) error

type Error

+ Data interface{}

+ Err string

+ func ErrByStatus(status int) *Error

+ func (err Error) Format() (string, error)

+ func (err Error) From(e error) *Error

+ func (err Error) GoString() string

+ func (err Error) WithCode(code int) *Error

+ func (err Error) WithErr(name string) *Error

+ func (err Error) WithMsg(msgs ...string) *Error

+ func (err Error) WithMsgf(format string, args ...interface{}) *Error

+ func (err Error) WithStack(skip ...int) *Error

+ type ErrorResponse struct

+ Error struct{ ... }

+ func ToErrorResponse(e error) ErrorResponse

+ type LoggerFilterWriter struct

+ func DefaultFilterWriter() *LoggerFilterWriter

+ func (s *LoggerFilterWriter) Add(err string)

+ func (s *LoggerFilterWriter) SetOutput(out io.Writer)

+ func (s *LoggerFilterWriter) Write(p []byte) (n int, err error)

+ type Sender interface

+ Send func(ctx *Context, code int, data interface{}) error

+ type URLParser interface

+ Parse func(val map[string][]string, body interface{}, tag string) error

Aug 23, 2021

Changes in this version

+ const SetNotify

Mar 9, 2021

Changes in this version

+ const SetDataPacking

type Context

+ func (ctx *Context) Proto(code int, body proto.Message, msg ...string) (err error)

Mar 5, 2017

Changes in this version

type Context

+ func (ctx *Context) Context() context.Context

Mar 1, 2017

Changes in this version

+ func ContentDisposition(fileName, dispositionType string) (header string)

Feb 28, 2017

Changes in this version

+ var ErrAnyKeyNonExistent = NewAppError("non-existent key")

+ var ErrBodyParserNotRegistered = NewAppError("bodyParser not registered")

+ var ErrMissingRequestBody = NewAppError("missing request body")

+ var ErrPusherNotImplemented = NewAppError("http.Pusher not implemented")

+ var ErrRendererNotRegistered = NewAppError("renderer not registered")

type App

+ func (app *App) Close(ctx ...context.Context) error

type Response

+ func (r *Response) Push(target string, opts *http.PushOptions) error

Feb 15, 2017

Changes in this version

type Context

+ func (ctx *Context) WithContext(c context.Context)

Feb 14, 2017

Changes in this version

+ func IsNil(val interface{}) bool

type App

+ func (app *App) Env() string

type Middleware

+ func Compose(mds ...Middleware) Middleware

Feb 7, 2017

Changes in this version

+ const SetBodyParser

+ const SetCompress

+ const SetEnv

+ const SetKeys

+ const SetLogger

+ const SetOnError

+ const SetRenderer

+ const SetTimeout

+ const SetWithContext

Feb 2, 2017

Changes in this version

type App

+ func (app *App) ServeHTTP(w http.ResponseWriter, r *http.Request)

Jan 13, 2017

Changes in this version

type Error

+ Stack string

+ func ErrorWithStack(v interface{}, skip ...int) *Error

Jan 12, 2017

Changes in this version

+ const HeaderContentSecurityPolicyReportOnly

+ const HeaderPublicKeyPins

+ const HeaderPublicKeyPinsReportOnly

+ const HeaderRefererPolicy

+ const HeaderXDNSPrefetchControl

+ const HeaderXDownloadOptions

type Context

+ func (ctx *Context) QueryAll(name string) []string

Jan 9, 2017

Changes in this version

+ type BodyParser interface

+ MaxBytes func() int64

+ Parse func(contentType string, buf []byte, body interface{}) error

+ type BodyTemplate interface

+ Validate func() error

type Context

+ func (ctx *Context) ErrorStatus(status int) (err error)

+ func (ctx *Context) ParseBody(body BodyTemplate) error

+ type DefaultBodyParser int64

+ func (d DefaultBodyParser) MaxBytes() int64

+ func (d DefaultBodyParser) Parse(contentType string, buf []byte, body interface{}) error

Jan 5, 2017

Changes in this version

type Context

+ func (ctx *Context) AcceptCharset(preferred ...string) string

+ func (ctx *Context) AcceptEncoding(preferred ...string) string

+ func (ctx *Context) AcceptLanguage(preferred ...string) string

+ func (ctx *Context) AcceptType(preferred ...string) string

type Response

+ func (r *Response) Vary(field string)

Dec 31, 2016

Changes in this version

type Response

+ func (r *Response) CloseNotify() <-chan bool

+ func (r *Response) Flush()

+ func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error)

Dec 29, 2016

Changes in this version

+ func IsStatusCode(status int) bool

Nov 22, 2016

Changes in this version

type RouterOptions

+ FixedPathRedirect bool

Nov 21, 2016

Changes in this version

+ type Compressible interface

+ Compressible func(contentType string, contentLength int) bool

Nov 14, 2016

Changes in this version

type Response

+ func (r *Response) ResetHeader(keepSubset bool)

Nov 12, 2016

Changes in this version

type Context

+ func (ctx *Context) Timing(dt time.Duration, fn func() interface{}) (interface{}, error)

Nov 9, 2016

Changes in this version

type Error

+ func (err *Error) String() string

Nov 8, 2016

Changes in this version

type Context

+ func (ctx *Context) QueryValues(name string) []string

+ type RouterOptions struct

+ IgnoreCase bool

+ Root string

+ TrailingSlashRedirect bool

Nov 5, 2016

Changes in this version

+ const HeaderAccept

+ const HeaderAcceptCharset

+ const HeaderAcceptDatetime

+ const HeaderAcceptLanguage

+ const HeaderAcceptPatch

+ const HeaderAcceptRanges

+ const HeaderCacheControl

+ const HeaderContentLanguage

+ const HeaderContentLocation

+ const HeaderContentMD5

+ const HeaderContentRange

+ const HeaderETag

+ const HeaderExpires

+ const HeaderIfMatch

+ const HeaderIfNoneMatch

+ const HeaderIfRange

+ const HeaderIfUnmodifiedSince

+ const HeaderLink

+ const HeaderMaxForwards

+ const HeaderP3P

+ const HeaderPragma

+ const HeaderProxyAuthenticate

+ const HeaderProxyAuthorization

+ const HeaderRange

+ const HeaderReferer

+ const HeaderRefresh

+ const HeaderRetryAfter

+ const HeaderTE

+ const HeaderVia

+ const HeaderWarning

+ const HeaderXContentSecurityPolicy

+ const HeaderXPoweredBy

+ const HeaderXRequestedWith

+ const HeaderXUACompatible

+ const HeaderXWebKitCSP

+ type Compress interface

+ Compressible func(contentType string) bool

+ Threshold func() int

+ type DefaultCompress struct

+ func (d *DefaultCompress) Compressible(contentType string) bool

+ func (d *DefaultCompress) Threshold() int

type Response

+ func (r *Response) HeaderWrote() bool

Nov 4, 2016

Changes in this version

+ const HeaderTransferEncoding

Nov 2, 2016

Changes in this version

type App

+ func (app *App) Set(setting string, val interface{})

type Context

+ func (ctx *Context) Setting(key string) interface{}

+ type DefaultOnError struct

+ func (o *DefaultOnError) OnError(ctx *Context, err error) *Error

+ type OnError interface

+ OnError func(*Context, error) *Error

Nov 1, 2016

Changes in this version

+ type App struct

+ ErrorLog *log.Logger

+ OnError func(*Context, error) *Error

+ Renderer Renderer

+ Server *http.Server

+ func (app *App) Error(err error)

+ func (app *App) Listen(addr string) error

+ func (app *App) ListenTLS(addr, certFile, keyFile string) error

+ func (app *App) Start(addr ...string) *ServerListener

+ func (app *App) Use(handle Middleware)

+ func (app *App) UseHandler(h Handler)

Oct 27, 2016

Changes in this version

+ type Any interface

+ New func(*Context) (interface{}, error)

type Context

+ func (ctx *Context) Any(any interface{}) (val interface{}, err error)

+ func (ctx *Context) SetAny(key, val interface{})

type Error

+ Meta interface{}

+ Msg string

+ func ParseError(e error, code ...int) *Error

+ func (err *Error) Error() string

type HTTPError

+ Error func() string

Oct 25, 2016

Changes in this version

+ const HeaderUserAgent

Oct 24, 2016

Changes in this version

+ const ColorCodeBlue

+ const ColorCodeCyan

+ const ColorCodeGray

+ const ColorCodeGreen

+ const ColorCodeMagenta

+ const ColorCodeRed

+ const ColorCodeWhite

+ const ColorCodeYellow

+ func ColorMethod(method string) string

+ func ColorStatus(code int) string

+ func ColorString(code int, str string) string

+ func NewAppError(err string) error

type Context

+ Log Log

+ type DefaultLogger struct

+ func (d *DefaultLogger) Format(l Log) string

+ func (d *DefaultLogger) Init(ctx *Context)

+ type Log map[string]interface

+ type Logger interface

+ Format func(Log) string

+ Init func(*Context)

type Middleware

+ func NewDefaultLogger() Middleware

+ func NewLogger(w io.Writer, l Logger) Middleware

Oct 23, 2016

Changes in this version

type Gear

+ func (g *Gear) Start(addr ...string) *ServerListener

+ type ServerListener struct

+ func (s *ServerListener) Addr() net.Addr

+ func (s *ServerListener) Close() error

+ func (s *ServerListener) Wait() error

Oct 23, 2016

Changes in this version

+ const Version

type Context

+ Req *http.Request

+ Res *Response

+ func NewContext(g *Gear) *Context

+ func (ctx *Context) Deadline() (time.Time, bool)

+ func (ctx *Context) Done() <-chan struct{}

+ func (ctx *Context) Err() error

+ func (ctx *Context) Reset(w http.ResponseWriter, req *http.Request)

+ func (ctx *Context) Value(key interface{}) (val interface{})

type Handler

+ Serve func(*Context) error

type Router

+ func (r *Router) Serve(ctx *Context) error

Oct 22, 2016

Changes in this version

+ type Error struct

+ Code int

+ func NewError(err error, code int) Error

+ func (err Error) Status() int

type Gear

+ func (g *Gear) Error(err error)

type HTTPError

+ Status func() int

type Middleware

+ func WrapHandler(h http.Handler) Middleware

+ func WrapHandlerFunc(h http.HandlerFunc) Middleware

Oct 22, 2016

Changes in this version

type Gear

+ func (g *Gear) StartBG(laddr string) *ServerBG

+ type ServerBG struct

+ func (s *ServerBG) Addr() net.Addr

+ func (s *ServerBG) Close() error

+ func (s *ServerBG) Wait() error

Oct 21, 2016

Changes in this version

+ const HeaderAcceptEncoding

+ const HeaderAccessControlAllowCredentials

+ const HeaderAccessControlAllowHeaders

+ const HeaderAccessControlAllowMethods

+ const HeaderAccessControlAllowOrigin

+ const HeaderAccessControlExposeHeaders

+ const HeaderAccessControlMaxAge

+ const HeaderAccessControlRequestHeaders

+ const HeaderAccessControlRequestMethod

+ const HeaderAllow

+ const HeaderAuthorization

+ const HeaderContentDisposition

+ const HeaderContentEncoding

+ const HeaderContentLength

+ const HeaderContentSecurityPolicy

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderIfModifiedSince

+ const HeaderLastModified

+ const HeaderLocation

+ const HeaderOrigin

+ const HeaderServer

+ const HeaderSetCookie

+ const HeaderStrictTransportSecurity

+ const HeaderUpgrade

+ const HeaderVary

+ const HeaderWWWAuthenticate

+ const HeaderXCSRFToken

+ const HeaderXContentTypeOptions

+ const HeaderXForwardedFor

+ const HeaderXForwardedProto

+ const HeaderXFrameOptions

+ const HeaderXHTTPMethodOverride

+ const HeaderXRealIP

+ const HeaderXXSSProtection

+ const MIMEApplicationForm

+ const MIMEApplicationJSON

+ const MIMEApplicationJSONCharsetUTF8

+ const MIMEApplicationJavaScript

+ const MIMEApplicationJavaScriptCharsetUTF8

+ const MIMEApplicationMsgpack

+ const MIMEApplicationProtobuf

+ const MIMEApplicationXML

+ const MIMEApplicationXMLCharsetUTF8

+ const MIMEMultipartForm

+ const MIMEOctetStream

+ const MIMETextHTML

+ const MIMETextHTMLCharsetUTF8

+ const MIMETextPlain

+ const MIMETextPlainCharsetUTF8

+ var GearLogsKey = &contextKey

+ var GearParamsKey = &contextKey

+ type Context interface

+ After func(hook Hook)

+ Attachment func(string, io.ReadSeeker) error

+ Body func(string)

+ Cancel func()

+ Cookie func(string) (*http.Cookie, error)

+ Cookies func() []*http.Cookie

+ End func(int, []byte)

+ Error func(*HTTPError)

+ Get func(string) string

+ HTML func(int, string) error

+ Host func() string

+ IP func() string

+ Inline func(string, io.ReadSeeker) error

+ IsEnded func() bool

+ JSON func(int, interface{}) error

+ JSONBlob func(int, []byte) error

+ JSONP func(int, string, interface{}) error

+ JSONPBlob func(int, string, []byte) error

+ Method func() string

+ OnEnd func(hook Hook)

+ Param func(string) string

+ Path func() string

+ Query func(string) string

+ Redirect func(int, string) error

+ Render func(int, string, interface{}) error

+ Request func() *http.Request

+ Response func() *Response

+ Set func(string, string)

+ SetCookie func(*http.Cookie)

+ SetValue func(interface{}, interface{})

+ Status func(int)

+ Stream func(int, string, io.Reader) error

+ String func() string

+ Type func(string)

+ WithCancel func() (context.Context, context.CancelFunc)

+ WithDeadline func(time.Time) (context.Context, context.CancelFunc)

+ WithTimeout func(time.Duration) (context.Context, context.CancelFunc)

+ WithValue func(interface{}, interface{}) context.Context

+ XML func(int, interface{}) error

+ XMLBlob func(int, []byte) error

+ type Gear struct

+ ErrorLog *log.Logger

+ OnCtxError func(Context, error) *HTTPError

+ Renderer Renderer

+ Server *http.Server

+ func New() *Gear

+ func (g *Gear) Listen(addr string) error

+ func (g *Gear) ListenTLS(addr, certFile, keyFile string) error

+ func (g *Gear) OnError(err error)

+ func (g *Gear) Use(handle Middleware)

+ func (g *Gear) UseHandler(h Handler)

+ type HTTPError struct

+ Code int

+ func NewHTTPError(code int, err string) *HTTPError

+ type Handler interface

+ Middleware func(Context) error

+ type Hook func(Context)

+ type Middleware func(Context) error

+ type Renderer interface

+ Render func(Context, io.Writer, string, interface{}) error

+ type Response struct

+ Body []byte

+ Status int

+ Type string

+ func (r *Response) Add(key, value string)

+ func (r *Response) Del(key string)

+ func (r *Response) Get(key string) string

+ func (r *Response) Header() http.Header

+ func (r *Response) Set(key, value string)

+ func (r *Response) Write(buf []byte) (int, error)

+ func (r *Response) WriteHeader(code int)

+ type Router struct

+ HandleOPTIONS bool

+ IsEndpoint bool

+ func NewRouter(root string, ignoreCase bool) *Router

+ func (r *Router) Del(pattern string, handle Middleware)

+ func (r *Router) Delete(pattern string, handle Middleware)

+ func (r *Router) Get(pattern string, handle Middleware)

+ func (r *Router) Handle(method, pattern string, handle Middleware)

+ func (r *Router) Head(pattern string, handle Middleware)

+ func (r *Router) Middleware(ctx Context) error

+ func (r *Router) Options(pattern string, handle Middleware)

+ func (r *Router) Otherwise(handle Middleware)

+ func (r *Router) Patch(pattern string, handle Middleware)

+ func (r *Router) Post(pattern string, handle Middleware)

+ func (r *Router) Put(pattern string, handle Middleware)

+ func (r *Router) Use(handle Middleware)