Documentation ¶
Overview ¶
Package echo implements high performance, minimalist Go web framework.
Example:
package main import ( "github.com/theopenlane/echox" "github.com/theopenlane/echox/middleware" "log" "net/http" ) // Handler func hello(c echox.Context) error { return c.String(http.StatusOK, "Hello, World!") } func main() { // Echo instance e := echox.New() // Middleware e.Use(middleware.Logger()) e.Use(middleware.Recover()) // Routes e.GET("/", hello) // Start server if err := e.Start(":8080"); err != http.ErrServerClosed { log.Fatal(err) } }
Learn more at https://echo.labstack.com
Index ¶
- Constants
- Variables
- func BindBody(c Context, i interface{}) (err error)
- func BindHeaders(c Context, i interface{}) error
- func BindPathParams(c Context, i interface{}) error
- func BindQueryParams(c Context, i interface{}) error
- func HandlerName(h HandlerFunc) string
- func MustSubFS(currentFs fs.FS, fsRoot string) fs.FS
- func NewBindingError(sourceParam string, values []string, message interface{}, internalError error) error
- type AddRouteError
- type BindUnmarshaler
- type Binder
- type BindingError
- type Context
- type DefaultBinder
- type DefaultContext
- func (c *DefaultContext) Attachment(file, name string) error
- func (c *DefaultContext) Bind(i interface{}) error
- func (c *DefaultContext) Blob(code int, contentType string, b []byte) (err error)
- func (c *DefaultContext) Cookie(name string) (*http.Cookie, error)
- func (c *DefaultContext) Cookies() []*http.Cookie
- func (c *DefaultContext) Echo() *Echo
- func (c *DefaultContext) Error(err error)
- func (c *DefaultContext) File(file string) error
- func (c *DefaultContext) FileFS(file string, filesystem fs.FS) error
- func (c *DefaultContext) FormFile(name string) (*multipart.FileHeader, error)
- func (c *DefaultContext) FormValue(name string) string
- func (c *DefaultContext) FormValueDefault(name, defaultValue string) string
- func (c *DefaultContext) FormValues() (url.Values, error)
- func (c *DefaultContext) Get(key string) interface{}
- func (c *DefaultContext) HTML(code int, html string) (err error)
- func (c *DefaultContext) HTMLBlob(code int, b []byte) (err error)
- func (c *DefaultContext) Inline(file, name string) error
- func (c *DefaultContext) IsTLS() bool
- func (c *DefaultContext) IsWebSocket() bool
- func (c *DefaultContext) JSON(code int, i interface{}) (err error)
- func (c *DefaultContext) JSONBlob(code int, b []byte) (err error)
- func (c *DefaultContext) JSONP(code int, callback string, i interface{}) (err error)
- func (c *DefaultContext) JSONPBlob(code int, callback string, b []byte) (err error)
- func (c *DefaultContext) JSONPretty(code int, i interface{}, indent string) (err error)
- func (c *DefaultContext) MultipartForm() (*multipart.Form, error)
- func (c *DefaultContext) NoContent(code int) error
- func (c *DefaultContext) Path() string
- func (c *DefaultContext) PathParam(name string) string
- func (c *DefaultContext) PathParamDefault(name, defaultValue string) string
- func (c *DefaultContext) PathParams() PathParams
- func (c *DefaultContext) QueryParam(name string) string
- func (c *DefaultContext) QueryParamDefault(name, defaultValue string) string
- func (c *DefaultContext) QueryParams() url.Values
- func (c *DefaultContext) QueryString() string
- func (c *DefaultContext) RawPathParams() *PathParams
- func (c *DefaultContext) RealIP() string
- func (c *DefaultContext) Redirect(code int, url string) error
- func (c *DefaultContext) Render(code int, name string, data interface{}) (err error)
- func (c *DefaultContext) Request() *http.Request
- func (c *DefaultContext) Reset(r *http.Request, w http.ResponseWriter)
- func (c *DefaultContext) Response() *Response
- func (c *DefaultContext) RouteInfo() RouteInfo
- func (c *DefaultContext) Scheme() string
- func (c *DefaultContext) Set(key string, val interface{})
- func (c *DefaultContext) SetCookie(cookie *http.Cookie)
- func (c *DefaultContext) SetPath(p string)
- func (c *DefaultContext) SetPathParams(params PathParams)
- func (c *DefaultContext) SetRawPathParams(params *PathParams)
- func (c *DefaultContext) SetRequest(r *http.Request)
- func (c *DefaultContext) SetResponse(r *Response)
- func (c *DefaultContext) SetRouteInfo(ri RouteInfo)
- func (c *DefaultContext) Stream(code int, contentType string, r io.Reader) (err error)
- func (c *DefaultContext) String(code int, s string) (err error)
- func (c *DefaultContext) Validate(i interface{}) error
- func (c *DefaultContext) XML(code int, i interface{}) (err error)
- func (c *DefaultContext) XMLBlob(code int, b []byte) (err error)
- func (c *DefaultContext) XMLPretty(code int, i interface{}, indent string) (err error)
- type DefaultJSONSerializer
- type DefaultRouter
- type Echo
- func (e *Echo) AcquireContext() Context
- func (e *Echo) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) RouteInfo
- func (e *Echo) AddRoute(route Routable) (RouteInfo, error)
- func (e *Echo) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) Routes
- func (e *Echo) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) File(path, file string, middleware ...MiddlewareFunc) RouteInfo
- func (e *Echo) FileFS(path, file string, filesystem fs.FS, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) GET(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) Group(prefix string, m ...MiddlewareFunc) (g *Group)
- func (e *Echo) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) Host(name string, m ...MiddlewareFunc) (g *Group)
- func (e *Echo) Match(methods []string, path string, handler HandlerFunc, ...) Routes
- func (e *Echo) NewContext(r *http.Request, w http.ResponseWriter) Context
- func (e *Echo) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) POST(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) Pre(middleware ...MiddlewareFunc)
- func (e *Echo) ReleaseContext(c Context)
- func (e *Echo) ResetRouterCreator(creator func(e *Echo) Router)
- func (e *Echo) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) Router() Router
- func (e *Echo) RouterFor(host string) (Router, bool)
- func (e *Echo) Routers() map[string]Router
- func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (e *Echo) Start(address string) error
- func (e *Echo) Static(pathPrefix, fsRoot string) RouteInfo
- func (e *Echo) StaticFS(pathPrefix string, filesystem fs.FS) RouteInfo
- func (e *Echo) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (e *Echo) Use(middleware ...MiddlewareFunc)
- type Group
- func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) RouteInfo
- func (g *Group) AddRoute(route Routable) (RouteInfo, error)
- func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) Routes
- func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) File(path, file string, middleware ...MiddlewareFunc) RouteInfo
- func (g *Group) FileFS(path, file string, filesystem fs.FS, m ...MiddlewareFunc) RouteInfo
- func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) Group(prefix string, middleware ...MiddlewareFunc) (sg *Group)
- func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) Match(methods []string, path string, handler HandlerFunc, ...) Routes
- func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) Static(pathPrefix, fsRoot string) RouteInfo
- func (g *Group) StaticFS(pathPrefix string, filesystem fs.FS) RouteInfo
- func (g *Group) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
- func (g *Group) Use(middleware ...MiddlewareFunc)
- type HTTPError
- type HTTPErrorHandler
- type HandlerFunc
- type IPExtractor
- type JSONSerializer
- type Logger
- type Map
- type MiddlewareConfigurator
- type MiddlewareFunc
- type PathParam
- type PathParams
- type Renderer
- type Response
- func (r *Response) After(fn func())
- func (r *Response) Before(fn func())
- func (r *Response) Flush()
- func (r *Response) Header() http.Header
- func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error)
- func (r *Response) Unwrap() http.ResponseWriter
- func (r *Response) Write(b []byte) (n int, err error)
- func (r *Response) WriteHeader(code int)
- type Routable
- type RoutableContext
- type Route
- type RouteInfo
- type Router
- type RouterConfig
- type Routes
- func (r Routes) FilterByMethod(method string) (Routes, error)
- func (r Routes) FilterByName(name string) (Routes, error)
- func (r Routes) FilterByPath(path string) (Routes, error)
- func (r Routes) FindByMethodPath(method string, path string) (RouteInfo, error)
- func (r Routes) Reverse(name string, params ...interface{}) (string, error)
- type ServableContext
- type StartConfig
- type TrustOption
- type Validator
- type ValueBinder
- func (b *ValueBinder) BindError() error
- func (b *ValueBinder) BindErrors() []error
- func (b *ValueBinder) BindUnmarshaler(sourceParam string, dest BindUnmarshaler) *ValueBinder
- func (b *ValueBinder) BindWithDelimiter(sourceParam string, dest interface{}, delimiter string) *ValueBinder
- func (b *ValueBinder) Bool(sourceParam string, dest *bool) *ValueBinder
- func (b *ValueBinder) Bools(sourceParam string, dest *[]bool) *ValueBinder
- func (b *ValueBinder) Byte(sourceParam string, dest *byte) *ValueBinder
- func (b *ValueBinder) CustomFunc(sourceParam string, customFunc func(values []string) []error) *ValueBinder
- func (b *ValueBinder) Duration(sourceParam string, dest *time.Duration) *ValueBinder
- func (b *ValueBinder) Durations(sourceParam string, dest *[]time.Duration) *ValueBinder
- func (b *ValueBinder) FailFast(value bool) *ValueBinder
- func (b *ValueBinder) Float32(sourceParam string, dest *float32) *ValueBinder
- func (b *ValueBinder) Float32s(sourceParam string, dest *[]float32) *ValueBinder
- func (b *ValueBinder) Float64(sourceParam string, dest *float64) *ValueBinder
- func (b *ValueBinder) Float64s(sourceParam string, dest *[]float64) *ValueBinder
- func (b *ValueBinder) Int(sourceParam string, dest *int) *ValueBinder
- func (b *ValueBinder) Int16(sourceParam string, dest *int16) *ValueBinder
- func (b *ValueBinder) Int16s(sourceParam string, dest *[]int16) *ValueBinder
- func (b *ValueBinder) Int32(sourceParam string, dest *int32) *ValueBinder
- func (b *ValueBinder) Int32s(sourceParam string, dest *[]int32) *ValueBinder
- func (b *ValueBinder) Int64(sourceParam string, dest *int64) *ValueBinder
- func (b *ValueBinder) Int64s(sourceParam string, dest *[]int64) *ValueBinder
- func (b *ValueBinder) Int8(sourceParam string, dest *int8) *ValueBinder
- func (b *ValueBinder) Int8s(sourceParam string, dest *[]int8) *ValueBinder
- func (b *ValueBinder) Ints(sourceParam string, dest *[]int) *ValueBinder
- func (b *ValueBinder) JSONUnmarshaler(sourceParam string, dest json.Unmarshaler) *ValueBinder
- func (b *ValueBinder) MustBindUnmarshaler(sourceParam string, dest BindUnmarshaler) *ValueBinder
- func (b *ValueBinder) MustBindWithDelimiter(sourceParam string, dest interface{}, delimiter string) *ValueBinder
- func (b *ValueBinder) MustBool(sourceParam string, dest *bool) *ValueBinder
- func (b *ValueBinder) MustBools(sourceParam string, dest *[]bool) *ValueBinder
- func (b *ValueBinder) MustByte(sourceParam string, dest *byte) *ValueBinder
- func (b *ValueBinder) MustCustomFunc(sourceParam string, customFunc func(values []string) []error) *ValueBinder
- func (b *ValueBinder) MustDuration(sourceParam string, dest *time.Duration) *ValueBinder
- func (b *ValueBinder) MustDurations(sourceParam string, dest *[]time.Duration) *ValueBinder
- func (b *ValueBinder) MustFloat32(sourceParam string, dest *float32) *ValueBinder
- func (b *ValueBinder) MustFloat32s(sourceParam string, dest *[]float32) *ValueBinder
- func (b *ValueBinder) MustFloat64(sourceParam string, dest *float64) *ValueBinder
- func (b *ValueBinder) MustFloat64s(sourceParam string, dest *[]float64) *ValueBinder
- func (b *ValueBinder) MustInt(sourceParam string, dest *int) *ValueBinder
- func (b *ValueBinder) MustInt16(sourceParam string, dest *int16) *ValueBinder
- func (b *ValueBinder) MustInt16s(sourceParam string, dest *[]int16) *ValueBinder
- func (b *ValueBinder) MustInt32(sourceParam string, dest *int32) *ValueBinder
- func (b *ValueBinder) MustInt32s(sourceParam string, dest *[]int32) *ValueBinder
- func (b *ValueBinder) MustInt64(sourceParam string, dest *int64) *ValueBinder
- func (b *ValueBinder) MustInt64s(sourceParam string, dest *[]int64) *ValueBinder
- func (b *ValueBinder) MustInt8(sourceParam string, dest *int8) *ValueBinder
- func (b *ValueBinder) MustInt8s(sourceParam string, dest *[]int8) *ValueBinder
- func (b *ValueBinder) MustInts(sourceParam string, dest *[]int) *ValueBinder
- func (b *ValueBinder) MustJSONUnmarshaler(sourceParam string, dest json.Unmarshaler) *ValueBinder
- func (b *ValueBinder) MustString(sourceParam string, dest *string) *ValueBinder
- func (b *ValueBinder) MustStrings(sourceParam string, dest *[]string) *ValueBinder
- func (b *ValueBinder) MustTextUnmarshaler(sourceParam string, dest encoding.TextUnmarshaler) *ValueBinder
- func (b *ValueBinder) MustTime(sourceParam string, dest *time.Time, layout string) *ValueBinder
- func (b *ValueBinder) MustTimes(sourceParam string, dest *[]time.Time, layout string) *ValueBinder
- func (b *ValueBinder) MustUint(sourceParam string, dest *uint) *ValueBinder
- func (b *ValueBinder) MustUint16(sourceParam string, dest *uint16) *ValueBinder
- func (b *ValueBinder) MustUint16s(sourceParam string, dest *[]uint16) *ValueBinder
- func (b *ValueBinder) MustUint32(sourceParam string, dest *uint32) *ValueBinder
- func (b *ValueBinder) MustUint32s(sourceParam string, dest *[]uint32) *ValueBinder
- func (b *ValueBinder) MustUint64(sourceParam string, dest *uint64) *ValueBinder
- func (b *ValueBinder) MustUint64s(sourceParam string, dest *[]uint64) *ValueBinder
- func (b *ValueBinder) MustUint8(sourceParam string, dest *uint8) *ValueBinder
- func (b *ValueBinder) MustUint8s(sourceParam string, dest *[]uint8) *ValueBinder
- func (b *ValueBinder) MustUints(sourceParam string, dest *[]uint) *ValueBinder
- func (b *ValueBinder) MustUnixTime(sourceParam string, dest *time.Time) *ValueBinder
- func (b *ValueBinder) MustUnixTimeMilli(sourceParam string, dest *time.Time) *ValueBinder
- func (b *ValueBinder) MustUnixTimeNano(sourceParam string, dest *time.Time) *ValueBinder
- func (b *ValueBinder) String(sourceParam string, dest *string) *ValueBinder
- func (b *ValueBinder) Strings(sourceParam string, dest *[]string) *ValueBinder
- func (b *ValueBinder) TextUnmarshaler(sourceParam string, dest encoding.TextUnmarshaler) *ValueBinder
- func (b *ValueBinder) Time(sourceParam string, dest *time.Time, layout string) *ValueBinder
- func (b *ValueBinder) Times(sourceParam string, dest *[]time.Time, layout string) *ValueBinder
- func (b *ValueBinder) Uint(sourceParam string, dest *uint) *ValueBinder
- func (b *ValueBinder) Uint16(sourceParam string, dest *uint16) *ValueBinder
- func (b *ValueBinder) Uint16s(sourceParam string, dest *[]uint16) *ValueBinder
- func (b *ValueBinder) Uint32(sourceParam string, dest *uint32) *ValueBinder
- func (b *ValueBinder) Uint32s(sourceParam string, dest *[]uint32) *ValueBinder
- func (b *ValueBinder) Uint64(sourceParam string, dest *uint64) *ValueBinder
- func (b *ValueBinder) Uint64s(sourceParam string, dest *[]uint64) *ValueBinder
- func (b *ValueBinder) Uint8(sourceParam string, dest *uint8) *ValueBinder
- func (b *ValueBinder) Uint8s(sourceParam string, dest *[]uint8) *ValueBinder
- func (b *ValueBinder) Uints(sourceParam string, dest *[]uint) *ValueBinder
- func (b *ValueBinder) UnixTime(sourceParam string, dest *time.Time) *ValueBinder
- func (b *ValueBinder) UnixTimeMilli(sourceParam string, dest *time.Time) *ValueBinder
- func (b *ValueBinder) UnixTimeNano(sourceParam string, dest *time.Time) *ValueBinder
Constants ¶
const ( MIMEApplicationJSON = "application/json" MIMEApplicationJSONCharsetUTF8 = MIMEApplicationJSON + "; " + charsetUTF8 MIMEApplicationJavaScript = "application/javascript" MIMEApplicationJavaScriptCharsetUTF8 = MIMEApplicationJavaScript + "; " + charsetUTF8 MIMEApplicationXML = "application/xml" MIMEApplicationXMLCharsetUTF8 = MIMEApplicationXML + "; " + charsetUTF8 MIMETextXML = "text/xml" MIMETextXMLCharsetUTF8 = MIMETextXML + "; " + charsetUTF8 MIMEApplicationForm = "application/x-www-form-urlencoded" MIMEApplicationProtobuf = "application/protobuf" MIMEApplicationMsgpack = "application/msgpack" MIMETextHTML = "text/html" MIMETextHTMLCharsetUTF8 = MIMETextHTML + "; " + charsetUTF8 MIMETextPlain = "text/plain" MIMETextPlainCharsetUTF8 = MIMETextPlain + "; " + charsetUTF8 MIMEMultipartForm = "multipart/form-data" MIMEOctetStream = "application/octet-stream" )
MIME types
const ( // PROPFIND Method can be used on collection and property resources. PROPFIND = "PROPFIND" // REPORT Method can be used to get information about a resource, see rfc 3253 REPORT = "REPORT" // RouteNotFound is special method type for routes handling "route not found" (404) cases RouteNotFound = "echo_route_not_found" )
const ( HeaderAccept = "Accept" HeaderAcceptEncoding = "Accept-Encoding" // HeaderAllow is the name of the "Allow" header field used to list the set of methods // advertised as supported by the target resource. Returning an Allow header is mandatory // for status 405 (method not found) and useful for the OPTIONS method in responses. // See RFC 7231: https://datatracker.ietf.org/doc/html/rfc7231#section-7.4.1 HeaderAllow = "Allow" HeaderAuthorization = "Authorization" HeaderContentDisposition = "Content-Disposition" HeaderContentEncoding = "Content-Encoding" HeaderContentLength = "Content-Length" HeaderContentType = "Content-Type" HeaderCookie = "Cookie" HeaderSetCookie = "Set-Cookie" HeaderIfModifiedSince = "If-Modified-Since" HeaderLastModified = "Last-Modified" HeaderLocation = "Location" HeaderRetryAfter = "Retry-After" HeaderUpgrade = "Upgrade" HeaderVary = "Vary" HeaderWWWAuthenticate = "WWW-Authenticate" HeaderXForwardedFor = "X-Forwarded-For" HeaderXForwardedProto = "X-Forwarded-Proto" HeaderXForwardedProtocol = "X-Forwarded-Protocol" HeaderXForwardedSsl = "X-Forwarded-Ssl" HeaderXUrlScheme = "X-Url-Scheme" HeaderXHTTPMethodOverride = "X-HTTP-Method-Override" HeaderXRealIP = "X-Real-Ip" HeaderXRequestID = "X-Request-Id" HeaderXCorrelationID = "X-Correlation-Id" HeaderXRequestedWith = "X-Requested-With" HeaderServer = "Server" HeaderOrigin = "Origin" HeaderCacheControl = "Cache-Control" HeaderConnection = "Connection" // Access control HeaderAccessControlRequestMethod = "Access-Control-Request-Method" HeaderAccessControlRequestHeaders = "Access-Control-Request-Headers" HeaderAccessControlAllowOrigin = "Access-Control-Allow-Origin" HeaderAccessControlAllowMethods = "Access-Control-Allow-Methods" HeaderAccessControlAllowHeaders = "Access-Control-Allow-Headers" HeaderAccessControlAllowCredentials = "Access-Control-Allow-Credentials" HeaderAccessControlExposeHeaders = "Access-Control-Expose-Headers" HeaderAccessControlMaxAge = "Access-Control-Max-Age" // Security HeaderStrictTransportSecurity = "Strict-Transport-Security" HeaderXContentTypeOptions = "X-Content-Type-Options" HeaderXXSSProtection = "X-XSS-Protection" HeaderXFrameOptions = "X-Frame-Options" HeaderContentSecurityPolicy = "Content-Security-Policy" HeaderContentSecurityPolicyReportOnly = "Content-Security-Policy-Report-Only" HeaderXCSRFToken = "X-CSRF-Token" // nolint: gosec HeaderReferrerPolicy = "Referrer-Policy" )
Headers
const ( // NotFoundRouteName is name of RouteInfo returned when router did not find matching route (404: not found). NotFoundRouteName = "echo_route_not_found_name" // MethodNotAllowedRouteName is name of RouteInfo returned when router did not find matching method for route (405: method not allowed). MethodNotAllowedRouteName = "echo_route_method_not_allowed_name" )
const ( // ContextKeyHeaderAllow is set by Router for getting value for `Allow` header in later stages of handler call chain. // Allow header is mandatory for status 405 (method not found) and useful for OPTIONS method requests. // It is added to context only when Router does not find matching method handler for request. ContextKeyHeaderAllow = "echo_header_allow" )
const (
// Version of Echo
Version = "5.0.0-alpha"
)
Variables ¶
var ( ErrUnsupportedMediaType = NewHTTPError(http.StatusUnsupportedMediaType) ErrNotFound = NewHTTPError(http.StatusNotFound) ErrForbidden = NewHTTPError(http.StatusForbidden) ErrMethodNotAllowed = NewHTTPError(http.StatusMethodNotAllowed) ErrStatusRequestEntityTooLarge = NewHTTPError(http.StatusRequestEntityTooLarge) ErrTooManyRequests = NewHTTPError(http.StatusTooManyRequests) ErrBadRequest = NewHTTPError(http.StatusBadRequest) ErrBadGateway = NewHTTPError(http.StatusBadGateway) ErrInternalServerError = NewHTTPError(http.StatusInternalServerError) ErrRequestTimeout = NewHTTPError(http.StatusRequestTimeout) ErrValidatorNotRegistered = errors.New("validator not registered") ErrRendererNotRegistered = errors.New("renderer not registered") ErrInvalidRedirectCode = errors.New("invalid redirect status code") ErrCookieNotFound = errors.New("cookie not found") ErrInvalidCertOrKeyType = errors.New("invalid cert or key type, must be string or []byte") ErrInvalidListenerNetwork = errors.New("invalid listener network") )
Errors
Functions ¶
func BindBody ¶
BindBody binds request body contents to bindable object NB: then binding forms take note that this implementation uses standard library form parsing which parses form data from BOTH URL and BODY if content type is not MIMEMultipartForm See non-MIMEMultipartForm: https://golang.org/pkg/net/http/#Request.ParseForm See MIMEMultipartForm: https://golang.org/pkg/net/http/#Request.ParseMultipartForm
func BindHeaders ¶
BindHeaders binds HTTP headers to a bindable object
func BindPathParams ¶
BindPathParams binds path params to bindable object
func BindQueryParams ¶
BindQueryParams binds query params to bindable object
func HandlerName ¶
func HandlerName(h HandlerFunc) string
HandlerName returns string name for given function.
func MustSubFS ¶
MustSubFS creates sub FS from current filesystem or panic on failure. Panic happens when `fsRoot` contains invalid path according to `fs.ValidPath` rules.
MustSubFS is helpful when dealing with `embed.FS` because for example `//go:embed assets/images` embeds files with paths including `assets/images` as their prefix. In that case use `fs := echox.MustSubFS(fs, "rootDirectory") to create sub fs which uses necessary prefix for directory path.
Types ¶
type AddRouteError ¶
AddRouteError is error returned by Router.Add containing information what actual route adding failed. Useful for mass adding (i.e. Any() routes)
func (*AddRouteError) Error ¶
func (e *AddRouteError) Error() string
func (*AddRouteError) Unwrap ¶
func (e *AddRouteError) Unwrap() error
type BindUnmarshaler ¶
type BindUnmarshaler interface { // UnmarshalParam decodes and assigns a value from an form or query param. UnmarshalParam(param string) error }
BindUnmarshaler is the interface used to wrap the UnmarshalParam method. Types that don't implement this, but do implement encoding.TextUnmarshaler will use that interface instead.
type BindingError ¶
type BindingError struct { // Field is the field name where value binding failed Field string `json:"field"` // Values of parameter that failed to bind. Values []string `json:"-"` *HTTPError }
BindingError represents an error that occurred while binding request data.
type Context ¶
type Context interface { // Request returns `*http.Request`. Request() *http.Request // SetRequest sets `*http.Request`. SetRequest(r *http.Request) // SetResponse sets `*Response`. SetResponse(r *Response) // Response returns `*Response`. Response() *Response // IsTLS returns true if HTTP connection is TLS otherwise false. IsTLS() bool // IsWebSocket returns true if HTTP connection is WebSocket otherwise false. IsWebSocket() bool // Scheme returns the HTTP protocol scheme, `http` or `https`. Scheme() string // RealIP returns the client's network address based on `X-Forwarded-For` // or `X-Real-IP` request header. // The behavior can be configured using `Echo#IPExtractor`. RealIP() string // RouteInfo returns current request route information. Method, Path, Name and params if they exist for matched route. // In case of 404 (route not found) and 405 (method not allowed) RouteInfo returns generic struct for these cases. RouteInfo() RouteInfo // Path returns the registered path for the handler. Path() string // PathParam returns path parameter by name. PathParam(name string) string // PathParamDefault returns the path parameter or default value for the provided name. // // Notes for DefaultRouter implementation: // Path parameter could be empty for cases like that: // * route `/release-:version/bin` and request URL is `/release-/bin` // * route `/api/:version/image.jpg` and request URL is `/api//image.jpg` // but not when path parameter is last part of route path // * route `/download/file.:ext` will not match request `/download/file.` PathParamDefault(name string, defaultValue string) string // PathParams returns path parameter values. PathParams() PathParams // SetPathParams sets path parameters for current request. SetPathParams(params PathParams) // QueryParam returns the query param for the provided name. QueryParam(name string) string // QueryParamDefault returns the query param or default value for the provided name. QueryParamDefault(name, defaultValue string) string // QueryParams returns the query parameters as `url.Values`. QueryParams() url.Values // QueryString returns the URL query string. QueryString() string // FormValue returns the form field value for the provided name. FormValue(name string) string // FormValueDefault returns the form field value or default value for the provided name. FormValueDefault(name, defaultValue string) string // FormValues returns the form field values as `url.Values`. FormValues() (url.Values, error) // FormFile returns the multipart form file for the provided name. FormFile(name string) (*multipart.FileHeader, error) // MultipartForm returns the multipart form. MultipartForm() (*multipart.Form, error) // Cookie returns the named cookie provided in the request. Cookie(name string) (*http.Cookie, error) // SetCookie adds a `Set-Cookie` header in HTTP response. SetCookie(cookie *http.Cookie) // Cookies returns the HTTP cookies sent with the request. Cookies() []*http.Cookie // Get retrieves data from the context. Get(key string) interface{} // Set saves data in the context. Set(key string, val interface{}) // Bind binds path params, query params and the request body into provided type `i`. The default binder // binds body based on Content-Type header. Bind(i interface{}) error // Validate validates provided `i`. It is usually called after `Context#Bind()`. // Validator must be registered using `Echo#Validator`. Validate(i interface{}) error // Render renders a template with data and sends a text/html response with status // code. Renderer must be registered using `Echo.Renderer`. Render(code int, name string, data interface{}) error // HTML sends an HTTP response with status code. HTML(code int, html string) error // HTMLBlob sends an HTTP blob response with status code. HTMLBlob(code int, b []byte) error // String sends a string response with status code. String(code int, s string) error // JSON sends a JSON response with status code. JSON(code int, i interface{}) error // JSONPretty sends a pretty-print JSON with status code. JSONPretty(code int, i interface{}, indent string) error // JSONBlob sends a JSON blob response with status code. JSONBlob(code int, b []byte) error // JSONP sends a JSONP response with status code. It uses `callback` to construct // the JSONP payload. JSONP(code int, callback string, i interface{}) error // JSONPBlob sends a JSONP blob response with status code. It uses `callback` // to construct the JSONP payload. JSONPBlob(code int, callback string, b []byte) error // XML sends an XML response with status code. XML(code int, i interface{}) error // XMLPretty sends a pretty-print XML with status code. XMLPretty(code int, i interface{}, indent string) error // XMLBlob sends an XML blob response with status code. XMLBlob(code int, b []byte) error // Blob sends a blob response with status code and content type. Blob(code int, contentType string, b []byte) error // Stream sends a streaming response with status code and content type. Stream(code int, contentType string, r io.Reader) error // File sends a response with the content of the file. File(file string) error // FileFS sends a response with the content of the file from given filesystem. FileFS(file string, filesystem fs.FS) error // Attachment sends a response as attachment, prompting client to save the // file. Attachment(file string, name string) error // Inline sends a response as inline, opening the file in the browser. Inline(file string, name string) error // NoContent sends a response with no body and a status code. NoContent(code int) error // Redirect redirects the request to a provided URL with status code. Redirect(code int, url string) error // Error invokes the registered global HTTP error handler. Generally used by middleware. // A side-effect of calling global error handler is that now Response has been committed (sent to the client) and // middlewares up in chain can not change Response status code or Response body anymore. // // Avoid using this method in handlers as no middleware will be able to effectively handle errors after that. // Instead of calling this method in handler return your error and let it be handled by middlewares or global error handler. Error(err error) // Echo returns the `Echo` instance. // // WARNING: Remember that Echo public fields and methods are coroutine safe ONLY when you are NOT mutating them // anywhere in your code after Echo server has started. Echo() *Echo }
Context represents the context of the current HTTP request. It holds request and response objects, path, path parameters, data and registered handler.
type DefaultBinder ¶
type DefaultBinder struct{}
DefaultBinder is the default implementation of the Binder interface.
func (*DefaultBinder) Bind ¶
func (b *DefaultBinder) Bind(c Context, i interface{}) (err error)
Bind implements the `Binder#Bind` function. Binding is done in following order: 1) path params; 2) query params; 3) request body. Each step COULD override previous step bound values. For single source binding use their own methods BindBody, BindQueryParams, BindPathParams.
type DefaultContext ¶
type DefaultContext struct {
// contains filtered or unexported fields
}
DefaultContext is default implementation of Context interface and can be embedded into structs to compose new Contexts with extended/modified behaviour.
func NewDefaultContext ¶
func NewDefaultContext(e *Echo, pathParamAllocSize int) *DefaultContext
NewDefaultContext creates new instance of DefaultContext. Argument pathParamAllocSize must be value that is stored in Echo.contextPathParamAllocSize field and is used to preallocate PathParams slice.
func (*DefaultContext) Attachment ¶
func (c *DefaultContext) Attachment(file, name string) error
Attachment sends a response as attachment, prompting client to save the file.
func (*DefaultContext) Bind ¶
func (c *DefaultContext) Bind(i interface{}) error
Bind binds path params, query params and the request body into provided type `i`. The default binder binds body based on Content-Type header.
func (*DefaultContext) Blob ¶
func (c *DefaultContext) Blob(code int, contentType string, b []byte) (err error)
Blob sends a blob response with status code and content type.
func (*DefaultContext) Cookie ¶
func (c *DefaultContext) Cookie(name string) (*http.Cookie, error)
Cookie returns the named cookie provided in the request.
func (*DefaultContext) Cookies ¶
func (c *DefaultContext) Cookies() []*http.Cookie
Cookies returns the HTTP cookies sent with the request.
func (*DefaultContext) Echo ¶
func (c *DefaultContext) Echo() *Echo
Echo returns the `Echo` instance.
func (*DefaultContext) Error ¶
func (c *DefaultContext) Error(err error)
Error invokes the registered global HTTP error handler. Generally used by middleware. A side-effect of calling global error handler is that now Response has been committed (sent to the client) and middlewares up in chain can not change Response status code or Response body anymore.
Avoid using this method in handlers as no middleware will be able to effectively handle errors after that. Instead of calling this method in handler return your error and let it be handled by middlewares or global error handler.
func (*DefaultContext) File ¶
func (c *DefaultContext) File(file string) error
File sends a response with the content of the file.
func (*DefaultContext) FileFS ¶
func (c *DefaultContext) FileFS(file string, filesystem fs.FS) error
FileFS serves file from given file system.
When dealing with `embed.FS` use `fs := echo.MustSubFS(fs, "rootDirectory") to create sub fs which uses necessary prefix for directory path. This is necessary as `//go:embed assets/images` embeds files with paths including `assets/images` as their prefix.
func (*DefaultContext) FormFile ¶
func (c *DefaultContext) FormFile(name string) (*multipart.FileHeader, error)
FormFile returns the multipart form file for the provided name.
func (*DefaultContext) FormValue ¶
func (c *DefaultContext) FormValue(name string) string
FormValue returns the form field value for the provided name.
func (*DefaultContext) FormValueDefault ¶
func (c *DefaultContext) FormValueDefault(name, defaultValue string) string
FormValueDefault returns the form field value or default value for the provided name. Note: FormValueDefault does not distinguish if form had no value by that name or value was empty string
func (*DefaultContext) FormValues ¶
func (c *DefaultContext) FormValues() (url.Values, error)
FormValues returns the form field values as `url.Values`.
func (*DefaultContext) Get ¶
func (c *DefaultContext) Get(key string) interface{}
Get retrieves data from the context.
func (*DefaultContext) HTML ¶
func (c *DefaultContext) HTML(code int, html string) (err error)
HTML sends an HTTP response with status code.
func (*DefaultContext) HTMLBlob ¶
func (c *DefaultContext) HTMLBlob(code int, b []byte) (err error)
HTMLBlob sends an HTTP blob response with status code.
func (*DefaultContext) Inline ¶
func (c *DefaultContext) Inline(file, name string) error
Inline sends a response as inline, opening the file in the browser.
func (*DefaultContext) IsTLS ¶
func (c *DefaultContext) IsTLS() bool
IsTLS returns true if HTTP connection is TLS otherwise false.
func (*DefaultContext) IsWebSocket ¶
func (c *DefaultContext) IsWebSocket() bool
IsWebSocket returns true if HTTP connection is WebSocket otherwise false.
func (*DefaultContext) JSON ¶
func (c *DefaultContext) JSON(code int, i interface{}) (err error)
JSON sends a JSON response with status code.
func (*DefaultContext) JSONBlob ¶
func (c *DefaultContext) JSONBlob(code int, b []byte) (err error)
JSONBlob sends a JSON blob response with status code.
func (*DefaultContext) JSONP ¶
func (c *DefaultContext) JSONP(code int, callback string, i interface{}) (err error)
JSONP sends a JSONP response with status code. It uses `callback` to construct the JSONP payload.
func (*DefaultContext) JSONPBlob ¶
func (c *DefaultContext) JSONPBlob(code int, callback string, b []byte) (err error)
JSONPBlob sends a JSONP blob response with status code. It uses `callback` to construct the JSONP payload.
func (*DefaultContext) JSONPretty ¶
func (c *DefaultContext) JSONPretty(code int, i interface{}, indent string) (err error)
JSONPretty sends a pretty-print JSON with status code.
func (*DefaultContext) MultipartForm ¶
func (c *DefaultContext) MultipartForm() (*multipart.Form, error)
MultipartForm returns the multipart form.
func (*DefaultContext) NoContent ¶
func (c *DefaultContext) NoContent(code int) error
NoContent sends a response with no body and a status code.
func (*DefaultContext) Path ¶
func (c *DefaultContext) Path() string
Path returns the registered path for the handler.
func (*DefaultContext) PathParam ¶
func (c *DefaultContext) PathParam(name string) string
PathParam returns path parameter by name.
func (*DefaultContext) PathParamDefault ¶
func (c *DefaultContext) PathParamDefault(name, defaultValue string) string
PathParamDefault returns the path parameter or default value for the provided name.
func (*DefaultContext) PathParams ¶
func (c *DefaultContext) PathParams() PathParams
PathParams returns path parameter values.
func (*DefaultContext) QueryParam ¶
func (c *DefaultContext) QueryParam(name string) string
QueryParam returns the query param for the provided name.
func (*DefaultContext) QueryParamDefault ¶
func (c *DefaultContext) QueryParamDefault(name, defaultValue string) string
QueryParamDefault returns the query param or default value for the provided name. Note: QueryParamDefault does not distinguish if query had no value by that name or value was empty string This means URLs `/test?search=` and `/test` would both return `1` for `c.QueryParamDefault("search", "1")`
func (*DefaultContext) QueryParams ¶
func (c *DefaultContext) QueryParams() url.Values
QueryParams returns the query parameters as `url.Values`.
func (*DefaultContext) QueryString ¶
func (c *DefaultContext) QueryString() string
QueryString returns the URL query string.
func (*DefaultContext) RawPathParams ¶
func (c *DefaultContext) RawPathParams() *PathParams
RawPathParams returns raw path pathParams value. Allocation of PathParams is handled by Context.
func (*DefaultContext) RealIP ¶
func (c *DefaultContext) RealIP() string
RealIP returns the client's network address based on `X-Forwarded-For` or `X-Real-IP` request header. The behavior can be configured using `Echo#IPExtractor`.
func (*DefaultContext) Redirect ¶
func (c *DefaultContext) Redirect(code int, url string) error
Redirect redirects the request to a provided URL with status code.
func (*DefaultContext) Render ¶
func (c *DefaultContext) Render(code int, name string, data interface{}) (err error)
Render renders a template with data and sends a text/html response with status code. Renderer must be registered using `Echo.Renderer`.
func (*DefaultContext) Request ¶
func (c *DefaultContext) Request() *http.Request
Request returns `*http.Request`.
func (*DefaultContext) Reset ¶
func (c *DefaultContext) Reset(r *http.Request, w http.ResponseWriter)
Reset resets the context after request completes. It must be called along with `Echo#AcquireContext()` and `Echo#ReleaseContext()`. See `Echo#ServeHTTP()`
func (*DefaultContext) Response ¶
func (c *DefaultContext) Response() *Response
Response returns `*Response`.
func (*DefaultContext) RouteInfo ¶
func (c *DefaultContext) RouteInfo() RouteInfo
RouteInfo returns current request route information. Method, Path, Name and params if they exist for matched route. In case of 404 (route not found) and 405 (method not allowed) RouteInfo returns generic struct for these cases.
func (*DefaultContext) Scheme ¶
func (c *DefaultContext) Scheme() string
Scheme returns the HTTP protocol scheme, `http` or `https`.
func (*DefaultContext) Set ¶
func (c *DefaultContext) Set(key string, val interface{})
Set saves data in the context.
func (*DefaultContext) SetCookie ¶
func (c *DefaultContext) SetCookie(cookie *http.Cookie)
SetCookie adds a `Set-Cookie` header in HTTP response.
func (*DefaultContext) SetPath ¶
func (c *DefaultContext) SetPath(p string)
SetPath sets the registered path for the handler.
func (*DefaultContext) SetPathParams ¶
func (c *DefaultContext) SetPathParams(params PathParams)
SetPathParams sets path parameters for current request.
func (*DefaultContext) SetRawPathParams ¶
func (c *DefaultContext) SetRawPathParams(params *PathParams)
SetRawPathParams replaces any existing param values with new values for this context lifetime (request).
DO NOT USE! Do not set any other value than what you got from RawPathParams as allocation of PathParams is handled by Context. If you mess up size of pathParams size your application will panic/crash during routing
func (*DefaultContext) SetRequest ¶
func (c *DefaultContext) SetRequest(r *http.Request)
SetRequest sets `*http.Request`.
func (*DefaultContext) SetResponse ¶
func (c *DefaultContext) SetResponse(r *Response)
SetResponse sets `*Response`.
func (*DefaultContext) SetRouteInfo ¶
func (c *DefaultContext) SetRouteInfo(ri RouteInfo)
SetRouteInfo sets the route info of this request to the context.
func (*DefaultContext) Stream ¶
Stream sends a streaming response with status code and content type.
func (*DefaultContext) String ¶
func (c *DefaultContext) String(code int, s string) (err error)
String sends a string response with status code.
func (*DefaultContext) Validate ¶
func (c *DefaultContext) Validate(i interface{}) error
Validate validates provided `i`. It is usually called after `Context#Bind()`. Validator must be registered using `Echo#Validator`.
func (*DefaultContext) XML ¶
func (c *DefaultContext) XML(code int, i interface{}) (err error)
XML sends an XML response with status code.
type DefaultJSONSerializer ¶
type DefaultJSONSerializer struct{}
DefaultJSONSerializer implements JSON encoding using encoding/json.
func (DefaultJSONSerializer) Deserialize ¶
func (d DefaultJSONSerializer) Deserialize(c Context, i interface{}) error
Deserialize reads a JSON from a request body and converts it into an interface.
type DefaultRouter ¶
type DefaultRouter struct {
// contains filtered or unexported fields
}
DefaultRouter is the registry of all registered routes for an `Echo` instance for request matching and URL path parameter parsing. Note: DefaultRouter is not coroutine-safe. Do not Add/Remove routes after HTTP server has been started with Echo.
func NewRouter ¶
func NewRouter(config RouterConfig) *DefaultRouter
NewRouter returns a new Router instance.
func (*DefaultRouter) Add ¶
func (r *DefaultRouter) Add(routable Routable) (RouteInfo, error)
Add registers a new route for method and path with matching handler.
func (*DefaultRouter) Remove ¶
func (r *DefaultRouter) Remove(method string, path string) error
Remove unregisters registered route
func (*DefaultRouter) Route ¶
func (r *DefaultRouter) Route(c RoutableContext) HandlerFunc
Route looks up a handler registered for method and path. It also parses URL for path parameters and loads them into context.
For performance:
- Get context from `Echo#AcquireContext()` - Reset it `Context#Reset()` - Return it `Echo#ReleaseContext()`.
func (*DefaultRouter) Routes ¶
func (r *DefaultRouter) Routes() Routes
Routes returns all registered routes
type Echo ¶
type Echo struct { // NewContextFunc allows using custom context implementations, instead of default *echox.context NewContextFunc func(e *Echo, pathParamAllocSize int) ServableContext Debug bool HTTPErrorHandler HTTPErrorHandler Binder Binder JSONSerializer JSONSerializer Validator Validator Renderer Renderer Logger Logger IPExtractor IPExtractor // Filesystem is file system used by Static and File handlers to access files. // Defaults to os.DirFS(".") // // When dealing with `embed.FS` use `fs := echox.MustSubFS(fs, "rootDirectory") to create sub fs which uses necessary // prefix for directory path. This is necessary as `//go:embed assets/images` embeds files with paths // including `assets/images` as their prefix. Filesystem fs.FS // OnAddRoute is called when Echo adds new route to specific host router. Handler is called for every router // and before route is added to the host router. OnAddRoute func(host string, route Routable) error // contains filtered or unexported fields }
Echo is the top-level framework instance.
Goroutine safety: Do not mutate Echo instance fields after server has started. Accessing these fields from handlers/middlewares and changing field values at the same time leads to data-races. Same rule applies to adding new routes after server has been started - Adding a route is not Goroutine safe action.
func (*Echo) AcquireContext ¶
AcquireContext returns an empty `Context` instance from the pool. You must return the context by calling `ReleaseContext()`.
func (*Echo) Add ¶
func (e *Echo) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) RouteInfo
Add registers a new route for an HTTP method and path with matching handler in the router with optional route-level middleware.
func (*Echo) Any ¶
func (e *Echo) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) Routes
Any registers a new route for all HTTP methods (supported by Echo) and path with matching handler in the router with optional route-level middleware.
Note: this method only adds specific set of supported HTTP methods as handler and is not true "catch-any-arbitrary-method" way of matching requests.
func (*Echo) CONNECT ¶
func (e *Echo) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
CONNECT registers a new CONNECT route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) DELETE ¶
func (e *Echo) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
DELETE registers a new DELETE route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) File ¶
func (e *Echo) File(path, file string, middleware ...MiddlewareFunc) RouteInfo
File registers a new route with path to serve a static file with optional route-level middleware. Panics on error.
func (*Echo) FileFS ¶
FileFS registers a new route with path to serve file from the provided file system.
func (*Echo) GET ¶
func (e *Echo) GET(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
GET registers a new GET route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) Group ¶
func (e *Echo) Group(prefix string, m ...MiddlewareFunc) (g *Group)
Group creates a new router group with prefix and optional group-level middleware.
func (*Echo) HEAD ¶
func (e *Echo) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
HEAD registers a new HEAD route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) Host ¶
func (e *Echo) Host(name string, m ...MiddlewareFunc) (g *Group)
Host creates a new router group for the provided host and optional host-level middleware.
func (*Echo) Match ¶
func (e *Echo) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) Routes
Match registers a new route for multiple HTTP methods and path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) NewContext ¶
NewContext returns a new Context instance.
Note: both request and response can be left to nil as Echo.ServeHTTP will call c.Reset(req,resp) anyway these arguments are useful when creating context for tests and cases like that.
func (*Echo) OPTIONS ¶
func (e *Echo) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
OPTIONS registers a new OPTIONS route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) PATCH ¶
func (e *Echo) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
PATCH registers a new PATCH route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) POST ¶
func (e *Echo) POST(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
POST registers a new POST route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) PUT ¶
func (e *Echo) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
PUT registers a new PUT route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) Pre ¶
func (e *Echo) Pre(middleware ...MiddlewareFunc)
Pre adds middleware to the chain which is run before router tries to find matching route. Meaning middleware is executed even for 404 (not found) cases.
func (*Echo) ReleaseContext ¶
ReleaseContext returns the `Context` instance back to the pool. You must call it after `AcquireContext()`.
func (*Echo) ResetRouterCreator ¶
ResetRouterCreator resets callback for creating new router instances. Note: current (default) router is immediately replaced with router created with creator func and vhost routers are cleared.
func (*Echo) RouteNotFound ¶
func (e *Echo) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
RouteNotFound registers a special-case route which is executed when no other route is found (i.e. HTTP 404 cases) for current request URL. Path supports static and named/any parameters just like other http method is defined. Generally path is ended with wildcard/match-any character (`/*`, `/download/*` etc).
Example: `e.RouteNotFound("/*", func(c echox.Context) error { return c.NoContent(http.StatusNotFound) })`
func (*Echo) RouterFor ¶
RouterFor returns Router for given host. When host is left empty the default router is returned.
func (*Echo) ServeHTTP ¶
func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements `http.Handler` interface, which serves HTTP requests.
func (*Echo) Start ¶
Start stars HTTP server on given address with Echo as a handler serving requests. The server can be shutdown by sending os.Interrupt signal with `ctrl+c`.
Note: this method is created for use in examples/demos and is deliberately simple without providing configuration options.
In need of customization use:
sc := echox.StartConfig{Address: ":8080"} if err := sc.Start(e); err != http.ErrServerClosed { log.Fatal(err) }
// or standard library `http.Server`
s := http.Server{Addr: ":8080", Handler: e} if err := s.ListenAndServe(); err != http.ErrServerClosed { log.Fatal(err) }
func (*Echo) Static ¶
Static registers a new route with path prefix to serve static files from the provided root directory.
func (*Echo) StaticFS ¶
StaticFS registers a new route with path prefix to serve static files from the provided file system.
When dealing with `embed.FS` use `fs := echox.MustSubFS(fs, "rootDirectory") to create sub fs which uses necessary prefix for directory path. This is necessary as `//go:embed assets/images` embeds files with paths including `assets/images` as their prefix.
func (*Echo) TRACE ¶
func (e *Echo) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
TRACE registers a new TRACE route for a path with matching handler in the router with optional route-level middleware. Panics on error.
func (*Echo) Use ¶
func (e *Echo) Use(middleware ...MiddlewareFunc)
Use adds middleware to the chain which is run after router has found matching route and before route/request handler method is executed.
type Group ¶
type Group struct {
// contains filtered or unexported fields
}
Group is a set of sub-routes for a specified route. It can be used for inner routes that share a common middleware or functionality that should be separate from the parent echo instance while still inheriting from it.
func (*Group) Add ¶
func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) RouteInfo
Add implements `Echo#Add()` for sub-routes within the Group. Panics on error.
func (*Group) Any ¶
func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) Routes
Any implements `Echo#Any()` for sub-routes within the Group. Panics on error.
func (*Group) CONNECT ¶
func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
CONNECT implements `Echo#CONNECT()` for sub-routes within the Group. Panics on error.
func (*Group) DELETE ¶
func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
DELETE implements `Echo#DELETE()` for sub-routes within the Group. Panics on error.
func (*Group) File ¶
func (g *Group) File(path, file string, middleware ...MiddlewareFunc) RouteInfo
File implements `Echo#File()` for sub-routes within the Group. Panics on error.
func (*Group) GET ¶
func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
GET implements `Echo#GET()` for sub-routes within the Group. Panics on error.
func (*Group) Group ¶
func (g *Group) Group(prefix string, middleware ...MiddlewareFunc) (sg *Group)
Group creates a new sub-group with prefix and optional sub-group-level middleware. Important! Group middlewares are only executed in case there was exact route match and not for 404 (not found) or 405 (method not allowed) cases. If this kind of behaviour is needed then add a catch-all route `/*` for the group which handler returns always 404
func (*Group) HEAD ¶
func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
HEAD implements `Echo#HEAD()` for sub-routes within the Group. Panics on error.
func (*Group) Match ¶
func (g *Group) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) Routes
Match implements `Echo#Match()` for sub-routes within the Group. Panics on error.
func (*Group) OPTIONS ¶
func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
OPTIONS implements `Echo#OPTIONS()` for sub-routes within the Group. Panics on error.
func (*Group) PATCH ¶
func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
PATCH implements `Echo#PATCH()` for sub-routes within the Group. Panics on error.
func (*Group) POST ¶
func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
POST implements `Echo#POST()` for sub-routes within the Group. Panics on error.
func (*Group) PUT ¶
func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
PUT implements `Echo#PUT()` for sub-routes within the Group. Panics on error.
func (*Group) RouteNotFound ¶
func (g *Group) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
RouteNotFound implements `Echo#RouteNotFound()` for sub-routes within the Group.
Example: `g.RouteNotFound("/*", func(c echo.Context) error { return c.NoContent(http.StatusNotFound) })`
func (*Group) StaticFS ¶
StaticFS implements `Echo#StaticFS()` for sub-routes within the Group.
When dealing with `embed.FS` use `fs := echo.MustSubFS(fs, "rootDirectory") to create sub fs which uses necessary prefix for directory path. This is necessary as `//go:embed assets/images` embeds files with paths including `assets/images` as their prefix.
func (*Group) TRACE ¶
func (g *Group) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) RouteInfo
TRACE implements `Echo#TRACE()` for sub-routes within the Group. Panics on error.
func (*Group) Use ¶
func (g *Group) Use(middleware ...MiddlewareFunc)
Use implements `Echo#Use()` for sub-routes within the Group. Group middlewares are not executed on request when there is no matching route found.
type HTTPError ¶
type HTTPError struct { Code int `json:"-"` Message interface{} `json:"message"` Internal error `json:"-"` // Stores the error returned by an external dependency }
HTTPError represents an error that occurred while handling a request.
func NewHTTPError ¶
NewHTTPError creates a new HTTPError instance.
func NewHTTPErrorWithInternal ¶
NewHTTPErrorWithInternal creates a new HTTPError instance with internal error set.
func (*HTTPError) WithInternal ¶
WithInternal returns clone of HTTPError with err set to HTTPError.Internal field
type HTTPErrorHandler ¶
HTTPErrorHandler is a centralized HTTP error handler.
func DefaultHTTPErrorHandler ¶
func DefaultHTTPErrorHandler(exposeError bool) HTTPErrorHandler
DefaultHTTPErrorHandler creates new default HTTP error handler implementation. It sends a JSON response with status code. `exposeError` parameter decides if returned message will contain also error message or not
Note: DefaultHTTPErrorHandler does not log errors. Use middleware for it if errors need to be logged (separately) Note: In case errors happens in middleware call-chain that is returning from handler (which did not return an error). When handler has already sent response (ala c.JSON()) and there is error in middleware that is returning from handler. Then the error that global error handler received will be ignored because we have already "committed" the response and status code header has been sent to the client.
type HandlerFunc ¶
HandlerFunc defines a function to serve HTTP requests.
func StaticDirectoryHandler ¶
func StaticDirectoryHandler(fileSystem fs.FS, disablePathUnescaping bool) HandlerFunc
StaticDirectoryHandler creates handler function to serve files from provided file system When disablePathUnescaping is set then file name from path is not unescaped and is served as is.
func StaticFileHandler ¶
func StaticFileHandler(file string, filesystem fs.FS) HandlerFunc
StaticFileHandler creates handler function to serve file from provided file system
func WrapHandler ¶
func WrapHandler(h http.Handler) HandlerFunc
WrapHandler wraps `http.Handler` into `echox.HandlerFunc`.
type IPExtractor ¶
IPExtractor is a function to extract IP addr from http.Request. Set appropriate one to Echo#IPExtractor. See https://echo.labstack.com/guide/ip-address for more details.
func ExtractIPDirect ¶
func ExtractIPDirect() IPExtractor
ExtractIPDirect extracts IP address using actual IP address. Use this if your server faces to internet directory (i.e.: uses no proxy).
func ExtractIPFromRealIPHeader ¶
func ExtractIPFromRealIPHeader(options ...TrustOption) IPExtractor
ExtractIPFromRealIPHeader extracts IP address using x-real-ip header. Use this if you put proxy which uses this header.
func ExtractIPFromXFFHeader ¶
func ExtractIPFromXFFHeader(options ...TrustOption) IPExtractor
ExtractIPFromXFFHeader extracts IP address using x-forwarded-for header. Use this if you put proxy which uses this header. This returns nearest untrustable IP. If all IPs are trustable, returns furthest one (i.e.: XFF[0]).
type JSONSerializer ¶
type JSONSerializer interface { Serialize(c Context, i interface{}, indent string) error Deserialize(c Context, i interface{}) error }
JSONSerializer is the interface that encodes and decodes JSON to and from interfaces.
type Logger ¶
type Logger interface { // Write provides writer interface for http.Server `ErrorLog` and for logging startup messages. // `http.Server.ErrorLog` logs errors from accepting connections, unexpected behavior from handlers, // and underlying FileSystem errors. // `logger` middleware will use this method to write its JSON payload. Write(p []byte) (n int, err error) // Error logs the error Error(err error) }
Logger defines the logging interface that Echo uses internally in few places. For logging in handlers use your own logger instance (dependency injected or package/public variable) from logging framework of your choice.
type Map ¶
type Map map[string]interface{}
Map defines a generic map of type `map[string]interface{}`.
type MiddlewareConfigurator ¶
type MiddlewareConfigurator interface {
ToMiddleware() (MiddlewareFunc, error)
}
MiddlewareConfigurator defines interface for creating middleware handlers with possibility to return configuration errors instead of panicking.
type MiddlewareFunc ¶
type MiddlewareFunc func(next HandlerFunc) HandlerFunc
MiddlewareFunc defines a function to process middleware.
func WrapMiddleware ¶
func WrapMiddleware(m func(http.Handler) http.Handler) MiddlewareFunc
WrapMiddleware wraps `func(http.Handler) http.Handler` into `echox.MiddlewareFunc`
type PathParams ¶
type PathParams []PathParam
PathParams is collections of PathParam instances with various helper methods
type Response ¶
type Response struct { Writer http.ResponseWriter Status int Size int64 Committed bool // contains filtered or unexported fields }
Response wraps an http.ResponseWriter and implements its interface to be used by an HTTP handler to construct an HTTP response. See: https://golang.org/pkg/net/http/#ResponseWriter
func NewResponse ¶
func NewResponse(w http.ResponseWriter, e *Echo) (r *Response)
NewResponse creates a new instance of Response.
func (*Response) After ¶
func (r *Response) After(fn func())
After registers a function which is called just after the response is written. If the `Content-Length` is unknown, none of the after function is executed.
func (*Response) Before ¶
func (r *Response) Before(fn func())
Before registers a function which is called just before the response is written.
func (*Response) Flush ¶
func (r *Response) Flush()
Flush implements the http.Flusher interface to allow an HTTP handler to flush buffered data to the client. See http.Flusher(https://golang.org/pkg/net/http/#Flusher)
func (*Response) Header ¶
Header returns the header map for the writer that will be sent by WriteHeader. Changing the header after a call to WriteHeader (or Write) has no effect unless the modified headers were declared as trailers by setting the "Trailer" header before the call to WriteHeader (see example) To suppress implicit response headers, set their value to nil. Example: https://golang.org/pkg/net/http/#example_ResponseWriter_trailers
func (*Response) Hijack ¶
Hijack implements the http.Hijacker interface to allow an HTTP handler to take over the connection. See http.Hijacker(https://golang.org/pkg/net/http/#Hijacker)
func (*Response) Unwrap ¶
func (r *Response) Unwrap() http.ResponseWriter
Unwrap returns the original http.ResponseWriter. ResponseController can be used to access the original http.ResponseWriter. See [https://go.dev/blog/go1.20]
func (*Response) WriteHeader ¶
WriteHeader sends an HTTP response header with status code. If WriteHeader is not called explicitly, the first call to Write will trigger an implicit WriteHeader(http.StatusOK). Thus explicit calls to WriteHeader are mainly used to send error codes.
type Routable ¶
type Routable interface { // ToRouteInfo converts Routable to RouteInfo // // This method is meant to be used by Router after it parses url for path parameters, to store information about // route just added. ToRouteInfo(params []string) RouteInfo // ToRoute converts Routable to Route which Router uses to register the method handler for path. // // This method is meant to be used by Router to get fields (including handler and middleware functions) needed to // add Route to Router. ToRoute() Route // ForGroup recreates routable with added group prefix and group middlewares it is grouped to. // // Is necessary for echox.Group to be able to add/register Routable with Router and having group prefix and group // middlewares included in actually registered Route. ForGroup(pathPrefix string, middlewares []MiddlewareFunc) Routable }
Routable is interface for registering Route with Router. During route registration process the Router will convert Routable to RouteInfo with ToRouteInfo method. By creating custom implementation of Routable additional information about registered route can be stored in Routes (i.e. privileges used with route etc.)
type RoutableContext ¶
type RoutableContext interface { // Request returns `*http.Request`. Request() *http.Request // RawPathParams returns raw path pathParams value. Allocation of PathParams is handled by Context. RawPathParams() *PathParams // SetRawPathParams replaces any existing param values with new values for this context lifetime (request). // Do not set any other value than what you got from RawPathParams as allocation of PathParams is handled by Context. SetRawPathParams(params *PathParams) // SetPath sets the registered path for the handler. SetPath(p string) // SetRouteInfo sets the route info of this request to the context. SetRouteInfo(ri RouteInfo) // Set saves data in the context. Allows router to store arbitrary (that only router has access to) data in context // for later use in middlewares/handler. Set(key string, val interface{}) }
RoutableContext is additional interface that structures implementing Context must implement. Methods inside this interface are meant for request routing purposes and should not be used in middlewares.
type Route ¶
type Route struct { Method string Path string Handler HandlerFunc Middlewares []MiddlewareFunc Name string }
Route contains information to adding/registering new route with the router. Method+Path pair uniquely identifies the Route. It is mandatory to provide Method+Path+Handler fields.
func (Route) ForGroup ¶
func (r Route) ForGroup(pathPrefix string, middlewares []MiddlewareFunc) Routable
ForGroup recreates Route with added group prefix and group middlewares it is grouped to.
func (Route) ToRoute ¶
ToRoute returns Route which Router uses to register the method handler for path.
func (Route) ToRouteInfo ¶
ToRouteInfo converts Route to RouteInfo
type RouteInfo ¶
type RouteInfo interface { Method() string Path() string Name() string Params() []string // Reverse reverses route to URL string by replacing path parameters with given params values. Reverse(params ...interface{}) string }
RouteInfo describes registered route base fields. Method+Path pair uniquely identifies the Route. Name can have duplicates.
type Router ¶
type Router interface { // Add registers Routable with the Router and returns registered RouteInfo Add(routable Routable) (RouteInfo, error) // Remove removes route from the Router Remove(method string, path string) error // Routes returns information about all registered routes Routes() Routes // Route searches Router for matching route and applies it to the given context. In case when no matching method // was not found (405) or no matching route exists for path (404), router will return its implementation of 405/404 // handler function. Route(c RoutableContext) HandlerFunc }
Router is interface for routing request contexts to registered routes.
Contract between Echo/Context instance and the router:
- all routes must be added through methods on echox.Echo instance. Reason: Echo instance uses RouteInfo.Params() length to allocate slice for paths parameters (see `Echo.contextPathParamAllocSize`).
- Router must populate Context during Router.Route call with:
- RoutableContext.SetPath
- RoutableContext.SetRawPathParams (IMPORTANT! with same slice pointer that c.RawPathParams() returns)
- RoutableContext.SetRouteInfo And optionally can set additional information to Context with RoutableContext.Set
type RouterConfig ¶
type RouterConfig struct { // AllowOverwritingRoute instructs Router NOT to return error when new route is registered with the same method+path // and replaces matching route with the new one. AllowOverwritingRoute bool // UnescapePathParamValues instructs Router to unescape path parameter value when request if matched to the routes UnescapePathParamValues bool // UseEscapedPathForMatching instructs Router to use escaped request URL path (req.URL.Path) for matching the request. UseEscapedPathForMatching bool // NotFoundHandler sets handler for case when router did not match any routes to the request path. HTTP error 404 (not found) NotFoundHandler HandlerFunc // MethodNotAllowedHandler sets handler for case when router did match router with path but not with current request // method. HTTP error 405 (method not allowed) MethodNotAllowedHandler HandlerFunc // OptionsMethodHandler sets handler for OPTIONS method. This has lower priority than handler set by `e.OPTIONS(path, ...)` // When `CORS` middleware is used this handler will not be called as `CORS` will terminate in case of OPTIONS method // middleware chain and actual handler will not be called. OptionsMethodHandler HandlerFunc }
RouterConfig is configuration options for (default) router
type Routes ¶
type Routes []RouteInfo
Routes is collection of RouteInfo instances with various helper methods.
func (Routes) FilterByMethod ¶
FilterByMethod searched for matching route info by method
func (Routes) FilterByName ¶
FilterByName searched for matching route info by name
func (Routes) FilterByPath ¶
FilterByPath searched for matching route info by path
func (Routes) FindByMethodPath ¶
FindByMethodPath searched for matching route info by method and path
type ServableContext ¶
type ServableContext interface { Context // minimal set of methods for middlewares and handler RoutableContext // minimal set for routing. These methods should not be accessed in middlewares/handlers // Reset resets the context after request completes. It must be called along // with `Echo#AcquireContext()` and `Echo#ReleaseContext()`. // See `Echo#ServeHTTP()` Reset(r *http.Request, w http.ResponseWriter) }
ServableContext is interface that Echo context implementation must implement to be usable in middleware/handlers and be able to be routed by Router.
type StartConfig ¶
type StartConfig struct { // Address for the server to listen on (if not using custom listener) Address string // ListenerNetwork allows setting listener network (see net.Listen for allowed values) // Optional: defaults to "tcp" ListenerNetwork string // CertFilesystem is file system used to load certificates and keys (if certs/keys are given as paths) CertFilesystem fs.FS // DisableHTTP2 disables supports for HTTP2 in TLS server DisableHTTP2 bool // HideBanner does not log Echo banner on server startup HideBanner bool // HidePort does not log port on server startup HidePort bool // GracefulContext is context that completion signals graceful shutdown start GracefulContext stdContext.Context // GracefulTimeout is period which server allows listeners to finish serving ongoing requests. If this time is exceeded process is exited // Defaults to 10 seconds GracefulTimeout time.Duration // OnShutdownError allows customization of what happens when (graceful) server Shutdown method returns an error. // Defaults to calling e.logger.Error(err) OnShutdownError func(err error) // TLSConfigFunc allows modifying TLS configuration before listener is created with it. TLSConfigFunc func(tlsConfig *tls.Config) // ListenerAddrFunc allows getting listener address before server starts serving requests on listener. Useful when // address is set as random (`:0`) port. ListenerAddrFunc func(addr net.Addr) // BeforeServeFunc allows customizing/accessing server before server starts serving requests on listener. BeforeServeFunc func(s *http.Server) error }
StartConfig is for creating configured http.Server instance to start serve http(s) requests with given Echo instance
func (StartConfig) Start ¶
func (sc StartConfig) Start(e *Echo) error
Start starts a HTTP(s) server.
func (StartConfig) StartTLS ¶
func (sc StartConfig) StartTLS(e *Echo, certFile, keyFile interface{}) error
StartTLS starts a HTTPS server. If `certFile` or `keyFile` is `string` the values are treated as file paths. If `certFile` or `keyFile` is `[]byte` the values are treated as the certificate or key as-is.
type TrustOption ¶
type TrustOption func(*ipChecker)
TrustOption is config for which IP address to trust
func TrustIPRange ¶
func TrustIPRange(ipRange *net.IPNet) TrustOption
TrustIPRange add trustable IP ranges using CIDR notation.
func TrustLinkLocal ¶
func TrustLinkLocal(v bool) TrustOption
TrustLinkLocal configures if you trust link-local address (default: true).
func TrustLoopback ¶
func TrustLoopback(v bool) TrustOption
TrustLoopback configures if you trust loopback address (default: true).
func TrustPrivateNet ¶
func TrustPrivateNet(v bool) TrustOption
TrustPrivateNet configures if you trust private network address (default: true).
type Validator ¶
type Validator interface {
Validate(i interface{}) error
}
Validator is the interface that wraps the Validate function.
type ValueBinder ¶
type ValueBinder struct { // ValueFunc is used to get single parameter (first) value from request ValueFunc func(sourceParam string) string // ValuesFunc is used to get all values for parameter from request. i.e. `/api/search?ids=1&ids=2` ValuesFunc func(sourceParam string) []string // ErrorFunc is used to create errors. Allows you to use your own error type, that for example marshals to your specific json response ErrorFunc func(sourceParam string, values []string, message interface{}, internalError error) error // contains filtered or unexported fields }
ValueBinder provides utility methods for binding query or path parameter to various Go built-in types
func FormFieldBinder ¶
func FormFieldBinder(c Context) *ValueBinder
FormFieldBinder creates form field value binder For all requests, FormFieldBinder parses the raw query from the URL and uses query params as form fields
For POST, PUT, and PATCH requests, it also reads the request body, parses it as a form and uses query params as form fields. Request body parameters take precedence over URL query string values in r.Form.
NB: when binding forms take note that this implementation uses standard library form parsing which parses form data from BOTH URL and BODY if content type is not MIMEMultipartForm See https://golang.org/pkg/net/http/#Request.ParseForm
func PathParamsBinder ¶
func PathParamsBinder(c Context) *ValueBinder
PathParamsBinder creates path parameter value binder
func QueryParamsBinder ¶
func QueryParamsBinder(c Context) *ValueBinder
QueryParamsBinder creates query parameter value binder
func (*ValueBinder) BindError ¶
func (b *ValueBinder) BindError() error
BindError returns first seen bind error and resets/empties binder errors for further calls
func (*ValueBinder) BindErrors ¶
func (b *ValueBinder) BindErrors() []error
BindErrors returns all bind errors and resets/empties binder errors for further calls
func (*ValueBinder) BindUnmarshaler ¶
func (b *ValueBinder) BindUnmarshaler(sourceParam string, dest BindUnmarshaler) *ValueBinder
BindUnmarshaler binds parameter to destination implementing BindUnmarshaler interface
func (*ValueBinder) BindWithDelimiter ¶
func (b *ValueBinder) BindWithDelimiter(sourceParam string, dest interface{}, delimiter string) *ValueBinder
BindWithDelimiter binds parameter to destination by suitable conversion function. Delimiter is used before conversion to split parameter value to separate values
func (*ValueBinder) Bool ¶
func (b *ValueBinder) Bool(sourceParam string, dest *bool) *ValueBinder
Bool binds parameter to bool variable
func (*ValueBinder) Bools ¶
func (b *ValueBinder) Bools(sourceParam string, dest *[]bool) *ValueBinder
Bools binds parameter values to slice of bool variables
func (*ValueBinder) Byte ¶
func (b *ValueBinder) Byte(sourceParam string, dest *byte) *ValueBinder
Byte binds parameter to byte variable
func (*ValueBinder) CustomFunc ¶
func (b *ValueBinder) CustomFunc(sourceParam string, customFunc func(values []string) []error) *ValueBinder
CustomFunc binds parameter values with Func. Func is called only when parameter values exist.
func (*ValueBinder) Duration ¶
func (b *ValueBinder) Duration(sourceParam string, dest *time.Duration) *ValueBinder
Duration binds parameter to time.Duration variable
func (*ValueBinder) Durations ¶
func (b *ValueBinder) Durations(sourceParam string, dest *[]time.Duration) *ValueBinder
Durations binds parameter values to slice of time.Duration variables
func (*ValueBinder) FailFast ¶
func (b *ValueBinder) FailFast(value bool) *ValueBinder
FailFast set internal flag to indicate if binding methods will return early (without binding) when previous bind failed NB: call this method before any other binding methods as it modifies binding methods behaviour
func (*ValueBinder) Float32 ¶
func (b *ValueBinder) Float32(sourceParam string, dest *float32) *ValueBinder
Float32 binds parameter to float32 variable
func (*ValueBinder) Float32s ¶
func (b *ValueBinder) Float32s(sourceParam string, dest *[]float32) *ValueBinder
Float32s binds parameter values to slice of float32 variables
func (*ValueBinder) Float64 ¶
func (b *ValueBinder) Float64(sourceParam string, dest *float64) *ValueBinder
Float64 binds parameter to float64 variable
func (*ValueBinder) Float64s ¶
func (b *ValueBinder) Float64s(sourceParam string, dest *[]float64) *ValueBinder
Float64s binds parameter values to slice of float64 variables
func (*ValueBinder) Int ¶
func (b *ValueBinder) Int(sourceParam string, dest *int) *ValueBinder
Int binds parameter to int variable
func (*ValueBinder) Int16 ¶
func (b *ValueBinder) Int16(sourceParam string, dest *int16) *ValueBinder
Int16 binds parameter to int16 variable
func (*ValueBinder) Int16s ¶
func (b *ValueBinder) Int16s(sourceParam string, dest *[]int16) *ValueBinder
Int16s binds parameter to slice of int16
func (*ValueBinder) Int32 ¶
func (b *ValueBinder) Int32(sourceParam string, dest *int32) *ValueBinder
Int32 binds parameter to int32 variable
func (*ValueBinder) Int32s ¶
func (b *ValueBinder) Int32s(sourceParam string, dest *[]int32) *ValueBinder
Int32s binds parameter to slice of int32
func (*ValueBinder) Int64 ¶
func (b *ValueBinder) Int64(sourceParam string, dest *int64) *ValueBinder
Int64 binds parameter to int64 variable
func (*ValueBinder) Int64s ¶
func (b *ValueBinder) Int64s(sourceParam string, dest *[]int64) *ValueBinder
Int64s binds parameter to slice of int64
func (*ValueBinder) Int8 ¶
func (b *ValueBinder) Int8(sourceParam string, dest *int8) *ValueBinder
Int8 binds parameter to int8 variable
func (*ValueBinder) Int8s ¶
func (b *ValueBinder) Int8s(sourceParam string, dest *[]int8) *ValueBinder
Int8s binds parameter to slice of int8
func (*ValueBinder) Ints ¶
func (b *ValueBinder) Ints(sourceParam string, dest *[]int) *ValueBinder
Ints binds parameter to slice of int
func (*ValueBinder) JSONUnmarshaler ¶
func (b *ValueBinder) JSONUnmarshaler(sourceParam string, dest json.Unmarshaler) *ValueBinder
JSONUnmarshaler binds parameter to destination implementing json.Unmarshaler interface
func (*ValueBinder) MustBindUnmarshaler ¶
func (b *ValueBinder) MustBindUnmarshaler(sourceParam string, dest BindUnmarshaler) *ValueBinder
MustBindUnmarshaler requires parameter value to exist to bind to destination implementing BindUnmarshaler interface. Returns error when value does not exist
func (*ValueBinder) MustBindWithDelimiter ¶
func (b *ValueBinder) MustBindWithDelimiter(sourceParam string, dest interface{}, delimiter string) *ValueBinder
MustBindWithDelimiter requires parameter value to exist to bind destination by suitable conversion function. Delimiter is used before conversion to split parameter value to separate values
func (*ValueBinder) MustBool ¶
func (b *ValueBinder) MustBool(sourceParam string, dest *bool) *ValueBinder
MustBool requires parameter value to exist to bind to bool variable. Returns error when value does not exist
func (*ValueBinder) MustBools ¶
func (b *ValueBinder) MustBools(sourceParam string, dest *[]bool) *ValueBinder
MustBools requires parameter values to exist to bind to slice of bool variables. Returns error when values does not exist
func (*ValueBinder) MustByte ¶
func (b *ValueBinder) MustByte(sourceParam string, dest *byte) *ValueBinder
MustByte requires parameter value to exist to bind to byte variable. Returns error when value does not exist
func (*ValueBinder) MustCustomFunc ¶
func (b *ValueBinder) MustCustomFunc(sourceParam string, customFunc func(values []string) []error) *ValueBinder
MustCustomFunc requires parameter values to exist to bind with Func. Returns error when value does not exist.
func (*ValueBinder) MustDuration ¶
func (b *ValueBinder) MustDuration(sourceParam string, dest *time.Duration) *ValueBinder
MustDuration requires parameter value to exist to bind to time.Duration variable. Returns error when value does not exist
func (*ValueBinder) MustDurations ¶
func (b *ValueBinder) MustDurations(sourceParam string, dest *[]time.Duration) *ValueBinder
MustDurations requires parameter values to exist to bind to slice of time.Duration variables. Returns error when values does not exist
func (*ValueBinder) MustFloat32 ¶
func (b *ValueBinder) MustFloat32(sourceParam string, dest *float32) *ValueBinder
MustFloat32 requires parameter value to exist to bind to float32 variable. Returns error when value does not exist
func (*ValueBinder) MustFloat32s ¶
func (b *ValueBinder) MustFloat32s(sourceParam string, dest *[]float32) *ValueBinder
MustFloat32s requires parameter values to exist to bind to slice of float32 variables. Returns error when values does not exist
func (*ValueBinder) MustFloat64 ¶
func (b *ValueBinder) MustFloat64(sourceParam string, dest *float64) *ValueBinder
MustFloat64 requires parameter value to exist to bind to float64 variable. Returns error when value does not exist
func (*ValueBinder) MustFloat64s ¶
func (b *ValueBinder) MustFloat64s(sourceParam string, dest *[]float64) *ValueBinder
MustFloat64s requires parameter values to exist to bind to slice of float64 variables. Returns error when values does not exist
func (*ValueBinder) MustInt ¶
func (b *ValueBinder) MustInt(sourceParam string, dest *int) *ValueBinder
MustInt requires parameter value to exist to bind to int variable. Returns error when value does not exist
func (*ValueBinder) MustInt16 ¶
func (b *ValueBinder) MustInt16(sourceParam string, dest *int16) *ValueBinder
MustInt16 requires parameter value to exist to bind to int16 variable. Returns error when value does not exist
func (*ValueBinder) MustInt16s ¶
func (b *ValueBinder) MustInt16s(sourceParam string, dest *[]int16) *ValueBinder
MustInt16s requires parameter value to exist to bind to int16 slice variable. Returns error when value does not exist
func (*ValueBinder) MustInt32 ¶
func (b *ValueBinder) MustInt32(sourceParam string, dest *int32) *ValueBinder
MustInt32 requires parameter value to exist to bind to int32 variable. Returns error when value does not exist
func (*ValueBinder) MustInt32s ¶
func (b *ValueBinder) MustInt32s(sourceParam string, dest *[]int32) *ValueBinder
MustInt32s requires parameter value to exist to bind to int32 slice variable. Returns error when value does not exist
func (*ValueBinder) MustInt64 ¶
func (b *ValueBinder) MustInt64(sourceParam string, dest *int64) *ValueBinder
MustInt64 requires parameter value to exist to bind to int64 variable. Returns error when value does not exist
func (*ValueBinder) MustInt64s ¶
func (b *ValueBinder) MustInt64s(sourceParam string, dest *[]int64) *ValueBinder
MustInt64s requires parameter value to exist to bind to int64 slice variable. Returns error when value does not exist
func (*ValueBinder) MustInt8 ¶
func (b *ValueBinder) MustInt8(sourceParam string, dest *int8) *ValueBinder
MustInt8 requires parameter value to exist to bind to int8 variable. Returns error when value does not exist
func (*ValueBinder) MustInt8s ¶
func (b *ValueBinder) MustInt8s(sourceParam string, dest *[]int8) *ValueBinder
MustInt8s requires parameter value to exist to bind to int8 slice variable. Returns error when value does not exist
func (*ValueBinder) MustInts ¶
func (b *ValueBinder) MustInts(sourceParam string, dest *[]int) *ValueBinder
MustInts requires parameter value to exist to bind to int slice variable. Returns error when value does not exist
func (*ValueBinder) MustJSONUnmarshaler ¶
func (b *ValueBinder) MustJSONUnmarshaler(sourceParam string, dest json.Unmarshaler) *ValueBinder
MustJSONUnmarshaler requires parameter value to exist to bind to destination implementing json.Unmarshaler interface. Returns error when value does not exist
func (*ValueBinder) MustString ¶
func (b *ValueBinder) MustString(sourceParam string, dest *string) *ValueBinder
MustString requires parameter value to exist to bind to string variable. Returns error when value does not exist
func (*ValueBinder) MustStrings ¶
func (b *ValueBinder) MustStrings(sourceParam string, dest *[]string) *ValueBinder
MustStrings requires parameter values to exist to bind to slice of string variables. Returns error when value does not exist
func (*ValueBinder) MustTextUnmarshaler ¶
func (b *ValueBinder) MustTextUnmarshaler(sourceParam string, dest encoding.TextUnmarshaler) *ValueBinder
MustTextUnmarshaler requires parameter value to exist to bind to destination implementing encoding.TextUnmarshaler interface. Returns error when value does not exist
func (*ValueBinder) MustTime ¶
func (b *ValueBinder) MustTime(sourceParam string, dest *time.Time, layout string) *ValueBinder
MustTime requires parameter value to exist to bind to time.Time variable. Returns error when value does not exist
func (*ValueBinder) MustTimes ¶
func (b *ValueBinder) MustTimes(sourceParam string, dest *[]time.Time, layout string) *ValueBinder
MustTimes requires parameter values to exist to bind to slice of time.Time variables. Returns error when values does not exist
func (*ValueBinder) MustUint ¶
func (b *ValueBinder) MustUint(sourceParam string, dest *uint) *ValueBinder
MustUint requires parameter value to exist to bind to uint variable. Returns error when value does not exist
func (*ValueBinder) MustUint16 ¶
func (b *ValueBinder) MustUint16(sourceParam string, dest *uint16) *ValueBinder
MustUint16 requires parameter value to exist to bind to uint16 variable. Returns error when value does not exist
func (*ValueBinder) MustUint16s ¶
func (b *ValueBinder) MustUint16s(sourceParam string, dest *[]uint16) *ValueBinder
MustUint16s requires parameter value to exist to bind to uint16 slice variable. Returns error when value does not exist
func (*ValueBinder) MustUint32 ¶
func (b *ValueBinder) MustUint32(sourceParam string, dest *uint32) *ValueBinder
MustUint32 requires parameter value to exist to bind to uint32 variable. Returns error when value does not exist
func (*ValueBinder) MustUint32s ¶
func (b *ValueBinder) MustUint32s(sourceParam string, dest *[]uint32) *ValueBinder
MustUint32s requires parameter value to exist to bind to uint32 slice variable. Returns error when value does not exist
func (*ValueBinder) MustUint64 ¶
func (b *ValueBinder) MustUint64(sourceParam string, dest *uint64) *ValueBinder
MustUint64 requires parameter value to exist to bind to uint64 variable. Returns error when value does not exist
func (*ValueBinder) MustUint64s ¶
func (b *ValueBinder) MustUint64s(sourceParam string, dest *[]uint64) *ValueBinder
MustUint64s requires parameter value to exist to bind to uint64 slice variable. Returns error when value does not exist
func (*ValueBinder) MustUint8 ¶
func (b *ValueBinder) MustUint8(sourceParam string, dest *uint8) *ValueBinder
MustUint8 requires parameter value to exist to bind to uint8 variable. Returns error when value does not exist
func (*ValueBinder) MustUint8s ¶
func (b *ValueBinder) MustUint8s(sourceParam string, dest *[]uint8) *ValueBinder
MustUint8s requires parameter value to exist to bind to uint8 slice variable. Returns error when value does not exist
func (*ValueBinder) MustUints ¶
func (b *ValueBinder) MustUints(sourceParam string, dest *[]uint) *ValueBinder
MustUints requires parameter value to exist to bind to uint slice variable. Returns error when value does not exist
func (*ValueBinder) MustUnixTime ¶
func (b *ValueBinder) MustUnixTime(sourceParam string, dest *time.Time) *ValueBinder
MustUnixTime requires parameter value to exist to bind to time.Duration variable (in local time corresponding to the given Unix time). Returns error when value does not exist.
Example: 1609180603 bind to 2020-12-28T18:36:43.000000000+00:00
Note:
- time.Time{} (param is empty) and time.Unix(0,0) (param = "0") are not equal
func (*ValueBinder) MustUnixTimeMilli ¶
func (b *ValueBinder) MustUnixTimeMilli(sourceParam string, dest *time.Time) *ValueBinder
MustUnixTimeMilli requires parameter value to exist to bind to time.Duration variable (in local time corresponding to the given Unix time in millisecond precision). Returns error when value does not exist.
Example: 1647184410140 bind to 2022-03-13T15:13:30.140000000+00:00
Note:
- time.Time{} (param is empty) and time.Unix(0,0) (param = "0") are not equal
func (*ValueBinder) MustUnixTimeNano ¶
func (b *ValueBinder) MustUnixTimeNano(sourceParam string, dest *time.Time) *ValueBinder
MustUnixTimeNano requires parameter value to exist to bind to time.Duration variable (in local Time corresponding to the given Unix time value in nano second precision). Returns error when value does not exist.
Example: 1609180603123456789 binds to 2020-12-28T18:36:43.123456789+00:00 Example: 1000000000 binds to 1970-01-01T00:00:01.000000000+00:00 Example: 999999999 binds to 1970-01-01T00:00:00.999999999+00:00
Note:
- time.Time{} (param is empty) and time.Unix(0,0) (param = "0") are not equal
- Javascript's Number type only has about 53 bits of precision (Number.MAX_SAFE_INTEGER = 9007199254740991). Compare it to 1609180603123456789 in example.
func (*ValueBinder) String ¶
func (b *ValueBinder) String(sourceParam string, dest *string) *ValueBinder
String binds parameter to string variable
func (*ValueBinder) Strings ¶
func (b *ValueBinder) Strings(sourceParam string, dest *[]string) *ValueBinder
Strings binds parameter values to slice of string
func (*ValueBinder) TextUnmarshaler ¶
func (b *ValueBinder) TextUnmarshaler(sourceParam string, dest encoding.TextUnmarshaler) *ValueBinder
TextUnmarshaler binds parameter to destination implementing encoding.TextUnmarshaler interface
func (*ValueBinder) Time ¶
func (b *ValueBinder) Time(sourceParam string, dest *time.Time, layout string) *ValueBinder
Time binds parameter to time.Time variable
func (*ValueBinder) Times ¶
func (b *ValueBinder) Times(sourceParam string, dest *[]time.Time, layout string) *ValueBinder
Times binds parameter values to slice of time.Time variables
func (*ValueBinder) Uint ¶
func (b *ValueBinder) Uint(sourceParam string, dest *uint) *ValueBinder
Uint binds parameter to uint variable
func (*ValueBinder) Uint16 ¶
func (b *ValueBinder) Uint16(sourceParam string, dest *uint16) *ValueBinder
Uint16 binds parameter to uint16 variable
func (*ValueBinder) Uint16s ¶
func (b *ValueBinder) Uint16s(sourceParam string, dest *[]uint16) *ValueBinder
Uint16s binds parameter to slice of uint16
func (*ValueBinder) Uint32 ¶
func (b *ValueBinder) Uint32(sourceParam string, dest *uint32) *ValueBinder
Uint32 binds parameter to uint32 variable
func (*ValueBinder) Uint32s ¶
func (b *ValueBinder) Uint32s(sourceParam string, dest *[]uint32) *ValueBinder
Uint32s binds parameter to slice of uint32
func (*ValueBinder) Uint64 ¶
func (b *ValueBinder) Uint64(sourceParam string, dest *uint64) *ValueBinder
Uint64 binds parameter to uint64 variable
func (*ValueBinder) Uint64s ¶
func (b *ValueBinder) Uint64s(sourceParam string, dest *[]uint64) *ValueBinder
Uint64s binds parameter to slice of uint64
func (*ValueBinder) Uint8 ¶
func (b *ValueBinder) Uint8(sourceParam string, dest *uint8) *ValueBinder
Uint8 binds parameter to uint8 variable
func (*ValueBinder) Uint8s ¶
func (b *ValueBinder) Uint8s(sourceParam string, dest *[]uint8) *ValueBinder
Uint8s binds parameter to slice of uint8
func (*ValueBinder) Uints ¶
func (b *ValueBinder) Uints(sourceParam string, dest *[]uint) *ValueBinder
Uints binds parameter to slice of uint
func (*ValueBinder) UnixTime ¶
func (b *ValueBinder) UnixTime(sourceParam string, dest *time.Time) *ValueBinder
UnixTime binds parameter to time.Time variable (in local Time corresponding to the given Unix time).
Example: 1609180603 bind to 2020-12-28T18:36:43.000000000+00:00
Note:
- time.Time{} (param is empty) and time.Unix(0,0) (param = "0") are not equal
func (*ValueBinder) UnixTimeMilli ¶
func (b *ValueBinder) UnixTimeMilli(sourceParam string, dest *time.Time) *ValueBinder
UnixTimeMilli binds parameter to time.Time variable (in local time corresponding to the given Unix time in millisecond precision).
Example: 1647184410140 bind to 2022-03-13T15:13:30.140000000+00:00
Note:
- time.Time{} (param is empty) and time.Unix(0,0) (param = "0") are not equal
func (*ValueBinder) UnixTimeNano ¶
func (b *ValueBinder) UnixTimeNano(sourceParam string, dest *time.Time) *ValueBinder
UnixTimeNano binds parameter to time.Time variable (in local time corresponding to the given Unix time in nanosecond precision).
Example: 1609180603123456789 binds to 2020-12-28T18:36:43.123456789+00:00 Example: 1000000000 binds to 1970-01-01T00:00:01.000000000+00:00 Example: 999999999 binds to 1970-01-01T00:00:00.999999999+00:00
Note:
- time.Time{} (param is empty) and time.Unix(0,0) (param = "0") are not equal
- Javascript's Number type only has about 53 bits of precision (Number.MAX_SAFE_INTEGER = 9007199254740991). Compare it to 1609180603123456789 in example.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
echocontext
Package echocontext adds the echo context to the parent context
|
Package echocontext adds the echo context to the parent context |