Documentation ¶
Overview ¶
Package echo implements high performance, minimalist Go web framework.
Example:
package main import ( "net/http" "github.com/labstack/echo/v4" "github.com/labstack/echo/v4/middleware" ) // Handler func hello(c echo.Context) error { return c.String(http.StatusOK, "Hello, World!") } func main() { // Echo instance e := echo.New() // Middleware e.Use(middleware.Logger()) e.Use(middleware.Recover()) // Routes e.GET("/", hello) // Start server e.Logger.Fatal(e.Start(":1323")) }
Learn more at https://echo.labstack.com
Index ¶
- Constants
- Variables
- func GetPath(r *http.Request) string
- func MustSubFS(currentFs fs.FS, fsRoot string) fs.FS
- func NewBindingError(sourceParam string, values []string, message interface{}, internalError error) error
- type BindUnmarshaler
- type Binder
- type BindingError
- type Context
- type DefaultBinder
- func (b *DefaultBinder) Bind(i interface{}, c Context) (err error)
- func (b *DefaultBinder) BindBody(c Context, i interface{}) (err error)
- func (b *DefaultBinder) BindHeaders(c Context, i interface{}) error
- func (b *DefaultBinder) BindPathParams(c Context, i interface{}) error
- func (b *DefaultBinder) BindQueryParams(c Context, i interface{}) error
- type DefaultJSONSerializer
- type Echo
- func (e *Echo) AcquireContext() Context
- func (e *Echo) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route
- func (e *Echo) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
- func (e *Echo) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) Close() error
- func (e *Echo) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) DefaultHTTPErrorHandler(err error, c Context)
- func (e *Echo) File(path, file string, m ...MiddlewareFunc) *Route
- func (e *Echo) FileFS(path, file string, filesystem fs.FS, m ...MiddlewareFunc) *Route
- func (e *Echo) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) Group(prefix string, m ...MiddlewareFunc) (g *Group)
- func (e *Echo) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) Host(name string, m ...MiddlewareFunc) (g *Group)
- func (e *Echo) ListenerAddr() net.Addr
- func (e *Echo) Match(methods []string, path string, handler HandlerFunc, ...) []*Route
- func (e *Echo) NewContext(r *http.Request, w http.ResponseWriter) Context
- func (e *Echo) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) Pre(middleware ...MiddlewareFunc)
- func (e *Echo) ReleaseContext(c Context)
- func (e *Echo) Reverse(name string, params ...interface{}) string
- func (e *Echo) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) Router() *Router
- func (e *Echo) Routers() map[string]*Router
- func (e *Echo) Routes() []*Route
- func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (e *Echo) Shutdown(ctx stdContext.Context) error
- func (e *Echo) Start(address string) error
- func (e *Echo) StartAutoTLS(address string) error
- func (e *Echo) StartH2CServer(address string, h2s *http2.Server) error
- func (e *Echo) StartServer(s *http.Server) (err error)
- func (e *Echo) StartTLS(address string, certFile, keyFile interface{}) (err error)
- func (e *Echo) Static(pathPrefix, fsRoot string) *Route
- func (e *Echo) StaticFS(pathPrefix string, filesystem fs.FS) *Route
- func (e *Echo) TLSListenerAddr() net.Addr
- func (e *Echo) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Echo) URI(handler HandlerFunc, params ...interface{}) string
- func (e *Echo) URL(h HandlerFunc, params ...interface{}) string
- func (e *Echo) Use(middleware ...MiddlewareFunc)
- type Group
- func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route
- func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
- func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) File(path, file string)
- func (g *Group) FileFS(path, file string, filesystem fs.FS, m ...MiddlewareFunc) *Route
- func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Group(prefix string, middleware ...MiddlewareFunc) (sg *Group)
- func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Match(methods []string, path string, handler HandlerFunc, ...) []*Route
- func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Static(pathPrefix, fsRoot string)
- func (g *Group) StaticFS(pathPrefix string, filesystem fs.FS)
- func (g *Group) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Use(middleware ...MiddlewareFunc)
- type HTTPError
- type HTTPErrorHandler
- type HandlerFunc
- type IPExtractor
- type JSONSerializer
- type Logger
- type Map
- type MiddlewareFunc
- type Renderer
- type Response
- type Route
- type Router
- 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
Examples ¶
Constants ¶
const ( CONNECT = http.MethodConnect DELETE = http.MethodDelete GET = http.MethodGet HEAD = http.MethodHead OPTIONS = http.MethodOptions PATCH = http.MethodPatch POST = http.MethodPost // PROPFIND = "PROPFIND" PUT = http.MethodPut TRACE = http.MethodTrace )
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
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" HeaderReferrerPolicy = "Referrer-Policy" )
Headers
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 = "4.10.2"
)
Variables ¶
var ( ErrBadRequest = NewHTTPError(http.StatusBadRequest) // HTTP 400 Bad Request ErrPaymentRequired = NewHTTPError(http.StatusPaymentRequired) // HTTP 402 Payment Required ErrForbidden = NewHTTPError(http.StatusForbidden) // HTTP 403 Forbidden ErrNotFound = NewHTTPError(http.StatusNotFound) // HTTP 404 Not Found ErrMethodNotAllowed = NewHTTPError(http.StatusMethodNotAllowed) // HTTP 405 Method Not Allowed ErrNotAcceptable = NewHTTPError(http.StatusNotAcceptable) // HTTP 406 Not Acceptable ErrProxyAuthRequired = NewHTTPError(http.StatusProxyAuthRequired) // HTTP 407 Proxy AuthRequired ErrRequestTimeout = NewHTTPError(http.StatusRequestTimeout) // HTTP 408 Request Timeout ErrConflict = NewHTTPError(http.StatusConflict) // HTTP 409 Conflict ErrGone = NewHTTPError(http.StatusGone) // HTTP 410 Gone ErrLengthRequired = NewHTTPError(http.StatusLengthRequired) // HTTP 411 Length Required ErrPreconditionFailed = NewHTTPError(http.StatusPreconditionFailed) // HTTP 412 Precondition Failed ErrStatusRequestEntityTooLarge = NewHTTPError(http.StatusRequestEntityTooLarge) // HTTP 413 Payload Too Large ErrRequestURITooLong = NewHTTPError(http.StatusRequestURITooLong) // HTTP 414 URI Too Long ErrUnsupportedMediaType = NewHTTPError(http.StatusUnsupportedMediaType) // HTTP 415 Unsupported Media Type ErrRequestedRangeNotSatisfiable = NewHTTPError(http.StatusRequestedRangeNotSatisfiable) // HTTP 416 Range Not Satisfiable ErrExpectationFailed = NewHTTPError(http.StatusExpectationFailed) // HTTP 417 Expectation Failed ErrTeapot = NewHTTPError(http.StatusTeapot) // HTTP 418 I'm a teapot ErrMisdirectedRequest = NewHTTPError(http.StatusMisdirectedRequest) // HTTP 421 Misdirected Request ErrUnprocessableEntity = NewHTTPError(http.StatusUnprocessableEntity) // HTTP 422 Unprocessable Entity ErrLocked = NewHTTPError(http.StatusLocked) // HTTP 423 Locked ErrFailedDependency = NewHTTPError(http.StatusFailedDependency) // HTTP 424 Failed Dependency ErrTooEarly = NewHTTPError(http.StatusTooEarly) // HTTP 425 Too Early ErrUpgradeRequired = NewHTTPError(http.StatusUpgradeRequired) // HTTP 426 Upgrade Required ErrPreconditionRequired = NewHTTPError(http.StatusPreconditionRequired) // HTTP 428 Precondition Required ErrTooManyRequests = NewHTTPError(http.StatusTooManyRequests) // HTTP 429 Too Many Requests ErrRequestHeaderFieldsTooLarge = NewHTTPError(http.StatusRequestHeaderFieldsTooLarge) // HTTP 431 Request Header Fields Too Large ErrInternalServerError = NewHTTPError(http.StatusInternalServerError) // HTTP 500 Internal Server Error ErrNotImplemented = NewHTTPError(http.StatusNotImplemented) // HTTP 501 Not Implemented ErrBadGateway = NewHTTPError(http.StatusBadGateway) // HTTP 502 Bad Gateway ErrGatewayTimeout = NewHTTPError(http.StatusGatewayTimeout) // HTTP 504 Gateway Timeout ErrHTTPVersionNotSupported = NewHTTPError(http.StatusHTTPVersionNotSupported) // HTTP 505 HTTP Version Not Supported ErrVariantAlsoNegotiates = NewHTTPError(http.StatusVariantAlsoNegotiates) // HTTP 506 Variant Also Negotiates ErrInsufficientStorage = NewHTTPError(http.StatusInsufficientStorage) // HTTP 507 Insufficient Storage ErrLoopDetected = NewHTTPError(http.StatusLoopDetected) // HTTP 508 Loop Detected ErrNotExtended = NewHTTPError(http.StatusNotExtended) // HTTP 510 Not Extended ErrNetworkAuthenticationRequired = NewHTTPError(http.StatusNetworkAuthenticationRequired) // HTTP 511 Network Authentication Required 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
var ( NotFoundHandler = func(c Context) error { return ErrNotFound } MethodNotAllowedHandler = func(c Context) error { routerAllowMethods, ok := c.Get(ContextKeyHeaderAllow).(string) if ok && routerAllowMethods != "" { c.Response().Header().Set(HeaderAllow, routerAllowMethods) } return ErrMethodNotAllowed } )
Error handlers
Functions ¶
func GetPath ¶ added in v4.1.17
GetPath returns RawPath, if it's empty returns Path from URL Difference between RawPath and Path is:
- Path is where request path is stored. Value is stored in decoded form: /%47%6f%2f becomes /Go/.
- RawPath is an optional field which only gets set if the default encoding is different from Path.
func MustSubFS ¶ added in v4.7.0
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 := echo.MustSubFS(fs, "rootDirectory") to create sub fs which uses necessary prefix for directory path.
Types ¶
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 ¶ added in v4.2.0
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.
func (*BindingError) Error ¶ added in v4.2.0
func (be *BindingError) Error() string
Error returns error message
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 // Path returns the registered path for the handler. Path() string // SetPath sets the registered path for the handler. SetPath(p string) // Param returns path parameter by name. Param(name string) string // ParamNames returns path parameter names. ParamNames() []string // SetParamNames sets path parameter names. SetParamNames(names ...string) // ParamValues returns path parameter values. ParamValues() []string // SetParamValues sets path parameter values. SetParamValues(values ...string) // QueryParam returns the query param for the provided name. QueryParam(name 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 // FormParams returns the form parameters as `url.Values`. FormParams() (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 the request body into provided type `i`. The default binder // does it 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 // 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. Error(err error) // Handler returns the matched handler by router. Handler() HandlerFunc // SetHandler sets the matched handler by router. SetHandler(h HandlerFunc) // Logger returns the `Logger` instance. Logger() Logger // SetLogger Set the logger SetLogger(l Logger) // Echo returns the `Echo` instance. Echo() *Echo // 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) }
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(i interface{}, c Context) (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 binded values. For single source binding use their own methods BindBody, BindQueryParams, BindPathParams.
func (*DefaultBinder) BindBody ¶ added in v4.2.0
func (b *DefaultBinder) BindBody(c Context, i interface{}) (err error)
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 (*DefaultBinder) BindHeaders ¶ added in v4.4.0
func (b *DefaultBinder) BindHeaders(c Context, i interface{}) error
BindHeaders binds HTTP headers to a bindable object
func (*DefaultBinder) BindPathParams ¶ added in v4.2.0
func (b *DefaultBinder) BindPathParams(c Context, i interface{}) error
BindPathParams binds path params to bindable object
func (*DefaultBinder) BindQueryParams ¶ added in v4.2.0
func (b *DefaultBinder) BindQueryParams(c Context, i interface{}) error
BindQueryParams binds query params to bindable object
type DefaultJSONSerializer ¶ added in v4.4.0
type DefaultJSONSerializer struct{}
DefaultJSONSerializer implements JSON encoding using encoding/json.
func (DefaultJSONSerializer) Deserialize ¶ added in v4.4.0
func (d DefaultJSONSerializer) Deserialize(c Context, i interface{}) error
Deserialize reads a JSON from a request body and converts it into an interface.
type Echo ¶
type Echo struct { StdLogger *stdLog.Logger Server *http.Server TLSServer *http.Server Listener net.Listener TLSListener net.Listener AutoTLSManager autocert.Manager DisableHTTP2 bool Debug bool HideBanner bool HidePort bool HTTPErrorHandler HTTPErrorHandler Binder Binder JSONSerializer JSONSerializer Validator Validator Renderer Renderer Logger Logger IPExtractor IPExtractor ListenerNetwork string // OnAddRouteHandler is called when Echo adds new route to specific host router. OnAddRouteHandler func(host string, route Route, handler HandlerFunc, middleware []MiddlewareFunc) // 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. Adding new routes after the server has been started is also not safe!
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) *Route
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) []*Route
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) *Route
CONNECT registers a new CONNECT route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) DELETE ¶
func (e *Echo) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
DELETE registers a new DELETE route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) DefaultHTTPErrorHandler ¶
DefaultHTTPErrorHandler is the default HTTP error handler. It sends a JSON response with status code.
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 "commited" the response and status code header has been sent to the client.
func (*Echo) File ¶
func (e *Echo) File(path, file string, m ...MiddlewareFunc) *Route
File registers a new route with path to serve a static file with optional route-level middleware.
func (*Echo) FileFS ¶ added in v4.7.0
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) *Route
GET registers a new GET route for a path with matching handler in the router with optional route-level middleware.
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) *Route
HEAD registers a new HEAD route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) Host ¶ added in v4.1.0
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) ListenerAddr ¶ added in v4.2.0
ListenerAddr returns net.Addr for Listener
func (*Echo) Match ¶
func (e *Echo) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
Match registers a new route for multiple HTTP methods and path with matching handler in the router with optional route-level middleware.
func (*Echo) NewContext ¶
NewContext returns a Context instance.
func (*Echo) OPTIONS ¶
func (e *Echo) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
OPTIONS registers a new OPTIONS route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) PATCH ¶
func (e *Echo) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PATCH registers a new PATCH route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) POST ¶
func (e *Echo) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
POST registers a new POST route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) PUT ¶
func (e *Echo) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PUT registers a new PUT route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) Pre ¶
func (e *Echo) Pre(middleware ...MiddlewareFunc)
Pre adds middleware to the chain which is run before router.
func (*Echo) ReleaseContext ¶
ReleaseContext returns the `Context` instance back to the pool. You must call it after `AcquireContext()`.
func (*Echo) RouteNotFound ¶ added in v4.8.0
func (e *Echo) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
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 echo.Context) error { return c.NoContent(http.StatusNotFound) })`
func (*Echo) Routes ¶
Routes returns the registered routes for default router. In case when Echo serves multiple hosts/domains use `e.Routers()["domain2.site"].Routes()` to get specific host routes.
func (*Echo) ServeHTTP ¶
func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements `http.Handler` interface, which serves HTTP requests.
func (*Echo) Shutdown ¶
func (e *Echo) Shutdown(ctx stdContext.Context) error
Shutdown stops the server gracefully. It internally calls `http.Server#Shutdown()`.
func (*Echo) StartAutoTLS ¶
StartAutoTLS starts an HTTPS server using certificates automatically installed from https://letsencrypt.org.
func (*Echo) StartH2CServer ¶ added in v4.1.15
StartH2CServer starts a custom http/2 server with h2c (HTTP/2 Cleartext).
func (*Echo) StartServer ¶
StartServer starts a custom http server.
func (*Echo) StartTLS ¶
StartTLS starts an 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.
func (*Echo) Static ¶
Static registers a new route with path prefix to serve static files from the provided root directory.
func (*Echo) StaticFS ¶ added in v4.7.0
StaticFS registers a new route with path prefix to serve static files from the provided 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 (*Echo) TLSListenerAddr ¶ added in v4.2.0
TLSListenerAddr returns net.Addr for TLSListener
func (*Echo) TRACE ¶
func (e *Echo) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
TRACE registers a new TRACE route for a path with matching handler in the router with optional route-level middleware.
func (*Echo) URI ¶
func (e *Echo) URI(handler HandlerFunc, params ...interface{}) string
URI generates an URI from handler.
func (*Echo) URL ¶
func (e *Echo) URL(h HandlerFunc, params ...interface{}) string
URL is an alias for `URI` function.
func (*Echo) Use ¶
func (e *Echo) Use(middleware ...MiddlewareFunc)
Use adds middleware to the chain which is run after router.
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) *Route
Add implements `Echo#Add()` for sub-routes within the Group.
func (*Group) Any ¶
func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
Any implements `Echo#Any()` for sub-routes within the Group.
func (*Group) CONNECT ¶
func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
CONNECT implements `Echo#CONNECT()` for sub-routes within the Group.
func (*Group) DELETE ¶
func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
DELETE implements `Echo#DELETE()` for sub-routes within the Group.
func (*Group) FileFS ¶ added in v4.7.0
FileFS implements `Echo#FileFS()` for sub-routes within the Group.
func (*Group) GET ¶
func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
GET implements `Echo#GET()` for sub-routes within the Group.
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.
func (*Group) HEAD ¶
func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
HEAD implements `Echo#HEAD()` for sub-routes within the Group.
func (*Group) Match ¶
func (g *Group) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
Match implements `Echo#Match()` for sub-routes within the Group.
func (*Group) OPTIONS ¶
func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
OPTIONS implements `Echo#OPTIONS()` for sub-routes within the Group.
func (*Group) PATCH ¶
func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PATCH implements `Echo#PATCH()` for sub-routes within the Group.
func (*Group) POST ¶
func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
POST implements `Echo#POST()` for sub-routes within the Group.
func (*Group) PUT ¶
func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PUT implements `Echo#PUT()` for sub-routes within the Group.
func (*Group) RouteNotFound ¶ added in v4.8.0
func (g *Group) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
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 ¶ added in v4.7.0
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) *Route
TRACE implements `Echo#TRACE()` for sub-routes within the Group.
func (*Group) Use ¶
func (g *Group) Use(middleware ...MiddlewareFunc)
Use implements `Echo#Use()` for sub-routes within the Group.
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 (*HTTPError) SetInternal ¶
SetInternal sets error to HTTPError.Internal
func (*HTTPError) WithInternal ¶ added in v4.10.0
WithInternal returns clone of HTTPError with err set to HTTPError.Internal field
type HTTPErrorHandler ¶
HTTPErrorHandler is a centralized HTTP error handler.
type HandlerFunc ¶
HandlerFunc defines a function to serve HTTP requests.
func StaticDirectoryHandler ¶ added in v4.7.0
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 ¶ added in v4.7.0
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 `echo.HandlerFunc`.
type IPExtractor ¶ added in v4.1.15
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 ¶ added in v4.1.15
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 ¶ added in v4.1.15
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 ¶ added in v4.1.15
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 ¶ added in v4.4.0
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 { Output() io.Writer SetOutput(w io.Writer) Prefix() string SetPrefix(p string) Level() log.Lvl SetLevel(v log.Lvl) SetHeader(h string) Print(i ...interface{}) Printf(format string, args ...interface{}) Printj(j log.JSON) Debug(i ...interface{}) Debugf(format string, args ...interface{}) Debugj(j log.JSON) Info(i ...interface{}) Infof(format string, args ...interface{}) Infoj(j log.JSON) Warn(i ...interface{}) Warnf(format string, args ...interface{}) Warnj(j log.JSON) Error(i ...interface{}) Errorf(format string, args ...interface{}) Errorj(j log.JSON) Fatal(i ...interface{}) Fatalj(j log.JSON) Fatalf(format string, args ...interface{}) Panic(i ...interface{}) Panicj(j log.JSON) Panicf(format string, args ...interface{}) }
Logger defines the logging interface.
type Map ¶
type Map map[string]interface{}
Map defines a generic map of type `map[string]interface{}`.
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 `echo.MiddlewareFunc`
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) 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 Route ¶
type Route struct { Method string `json:"method"` Path string `json:"path"` Name string `json:"name"` }
Route contains a handler and information for matching against requests.
type Router ¶
type Router struct {
// contains filtered or unexported fields
}
Router is the registry of all registered routes for an `Echo` instance for request matching and URL path parameter parsing.
func (*Router) Add ¶
func (r *Router) Add(method, path string, h HandlerFunc)
Add registers a new route for method and path with matching handler.
func (*Router) Find ¶
Find lookup a handler registered for method and path. It also parses URL for path parameters and load them into context.
For performance:
- Get context from `Echo#AcquireContext()` - Reset it `Context#Reset()` - Return it `Echo#ReleaseContext()`.
type TrustOption ¶ added in v4.1.15
type TrustOption func(*ipChecker)
TrustOption is config for which IP address to trust
func TrustIPRange ¶ added in v4.1.15
func TrustIPRange(ipRange *net.IPNet) TrustOption
TrustIPRange add trustable IP ranges using CIDR notation.
func TrustLinkLocal ¶ added in v4.1.15
func TrustLinkLocal(v bool) TrustOption
TrustLinkLocal configures if you trust link-local address (default: true).
func TrustLoopback ¶ added in v4.1.15
func TrustLoopback(v bool) TrustOption
TrustLoopback configures if you trust loopback address (default: true).
func TrustPrivateNet ¶ added in v4.1.15
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
func PathParamsBinder(c Context) *ValueBinder
PathParamsBinder creates path parameter value binder
func QueryParamsBinder ¶ added in v4.2.0
func QueryParamsBinder(c Context) *ValueBinder
QueryParamsBinder creates query parameter value binder
func (*ValueBinder) BindError ¶ added in v4.2.0
func (b *ValueBinder) BindError() error
BindError returns first seen bind error and resets/empties binder errors for further calls
Example ¶
// example route function that binds query params to different destinations and stops binding on first bind error failFastRouteFunc := func(c echo.Context) error { var opts struct { Active bool IDs []int64 } length := int64(50) // default length is 50 // create binder that stops binding at first error b := echo.QueryParamsBinder(c) err := b.Int64("length", &length). Int64s("ids", &opts.IDs). Bool("active", &opts.Active). BindError() // returns first binding error if err != nil { bErr := err.(*echo.BindingError) return fmt.Errorf("my own custom error for field: %s values: %v", bErr.Field, bErr.Values) } fmt.Printf("active = %v, length = %v, ids = %v\n", opts.Active, length, opts.IDs) return c.JSON(http.StatusOK, opts) } e := echo.New() c := e.NewContext( httptest.NewRequest(http.MethodGet, "/api/endpoint?active=true&length=25&ids=1&ids=2&ids=3", nil), httptest.NewRecorder(), ) _ = failFastRouteFunc(c)
Output: active = true, length = 25, ids = [1 2 3]
func (*ValueBinder) BindErrors ¶ added in v4.2.0
func (b *ValueBinder) BindErrors() []error
BindErrors returns all bind errors and resets/empties binder errors for further calls
Example ¶
// example route function that binds query params to different destinations and returns all bind errors in one go routeFunc := func(c echo.Context) error { var opts struct { Active bool IDs []int64 } length := int64(50) // default length is 50 b := echo.QueryParamsBinder(c) errs := b.Int64("length", &length). Int64s("ids", &opts.IDs). Bool("active", &opts.Active). BindErrors() // returns all errors if errs != nil { for _, err := range errs { bErr := err.(*echo.BindingError) log.Printf("in case you want to access what field: %s values: %v failed", bErr.Field, bErr.Values) } return fmt.Errorf("%v fields failed to bind", len(errs)) } fmt.Printf("active = %v, length = %v, ids = %v", opts.Active, length, opts.IDs) return c.JSON(http.StatusOK, opts) } e := echo.New() c := e.NewContext( httptest.NewRequest(http.MethodGet, "/api/endpoint?active=true&length=25&ids=1&ids=2&ids=3", nil), httptest.NewRecorder(), ) _ = routeFunc(c)
Output: active = true, length = 25, ids = [1 2 3]
func (*ValueBinder) BindUnmarshaler ¶ added in v4.2.0
func (b *ValueBinder) BindUnmarshaler(sourceParam string, dest BindUnmarshaler) *ValueBinder
BindUnmarshaler binds parameter to destination implementing BindUnmarshaler interface
func (*ValueBinder) BindWithDelimiter ¶ added in v4.2.0
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 ¶ added in v4.2.0
func (b *ValueBinder) Bool(sourceParam string, dest *bool) *ValueBinder
Bool binds parameter to bool variable
func (*ValueBinder) Bools ¶ added in v4.2.0
func (b *ValueBinder) Bools(sourceParam string, dest *[]bool) *ValueBinder
Bools binds parameter values to slice of bool variables
func (*ValueBinder) Byte ¶ added in v4.2.0
func (b *ValueBinder) Byte(sourceParam string, dest *byte) *ValueBinder
Byte binds parameter to byte variable
func (*ValueBinder) CustomFunc ¶ added in v4.2.0
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.
Example ¶
// example route function that binds query params using custom function closure routeFunc := func(c echo.Context) error { length := int64(50) // default length is 50 var binary []byte b := echo.QueryParamsBinder(c) errs := b.Int64("length", &length). CustomFunc("base64", func(values []string) []error { if len(values) == 0 { return nil } decoded, err := base64.URLEncoding.DecodeString(values[0]) if err != nil { // in this example we use only first param value but url could contain multiple params in reality and // therefore in theory produce multiple binding errors return []error{echo.NewBindingError("base64", values[0:1], "failed to decode base64", err)} } binary = decoded return nil }). BindErrors() // returns all errors if errs != nil { for _, err := range errs { bErr := err.(*echo.BindingError) log.Printf("in case you want to access what field: %s values: %v failed", bErr.Field, bErr.Values) } return fmt.Errorf("%v fields failed to bind", len(errs)) } fmt.Printf("length = %v, base64 = %s", length, binary) return c.JSON(http.StatusOK, "ok") } e := echo.New() c := e.NewContext( httptest.NewRequest(http.MethodGet, "/api/endpoint?length=25&base64=SGVsbG8gV29ybGQ%3D", nil), httptest.NewRecorder(), ) _ = routeFunc(c)
Output: length = 25, base64 = Hello World
func (*ValueBinder) Duration ¶ added in v4.2.0
func (b *ValueBinder) Duration(sourceParam string, dest *time.Duration) *ValueBinder
Duration binds parameter to time.Duration variable
func (*ValueBinder) Durations ¶ added in v4.2.0
func (b *ValueBinder) Durations(sourceParam string, dest *[]time.Duration) *ValueBinder
Durations binds parameter values to slice of time.Duration variables
func (*ValueBinder) FailFast ¶ added in v4.2.0
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 ¶ added in v4.2.0
func (b *ValueBinder) Float32(sourceParam string, dest *float32) *ValueBinder
Float32 binds parameter to float32 variable
func (*ValueBinder) Float32s ¶ added in v4.2.0
func (b *ValueBinder) Float32s(sourceParam string, dest *[]float32) *ValueBinder
Float32s binds parameter values to slice of float32 variables
func (*ValueBinder) Float64 ¶ added in v4.2.0
func (b *ValueBinder) Float64(sourceParam string, dest *float64) *ValueBinder
Float64 binds parameter to float64 variable
func (*ValueBinder) Float64s ¶ added in v4.2.0
func (b *ValueBinder) Float64s(sourceParam string, dest *[]float64) *ValueBinder
Float64s binds parameter values to slice of float64 variables
func (*ValueBinder) Int ¶ added in v4.2.0
func (b *ValueBinder) Int(sourceParam string, dest *int) *ValueBinder
Int binds parameter to int variable
func (*ValueBinder) Int16 ¶ added in v4.2.0
func (b *ValueBinder) Int16(sourceParam string, dest *int16) *ValueBinder
Int16 binds parameter to int16 variable
func (*ValueBinder) Int16s ¶ added in v4.2.0
func (b *ValueBinder) Int16s(sourceParam string, dest *[]int16) *ValueBinder
Int16s binds parameter to slice of int16
func (*ValueBinder) Int32 ¶ added in v4.2.0
func (b *ValueBinder) Int32(sourceParam string, dest *int32) *ValueBinder
Int32 binds parameter to int32 variable
func (*ValueBinder) Int32s ¶ added in v4.2.0
func (b *ValueBinder) Int32s(sourceParam string, dest *[]int32) *ValueBinder
Int32s binds parameter to slice of int32
func (*ValueBinder) Int64 ¶ added in v4.2.0
func (b *ValueBinder) Int64(sourceParam string, dest *int64) *ValueBinder
Int64 binds parameter to int64 variable
func (*ValueBinder) Int64s ¶ added in v4.2.0
func (b *ValueBinder) Int64s(sourceParam string, dest *[]int64) *ValueBinder
Int64s binds parameter to slice of int64
func (*ValueBinder) Int8 ¶ added in v4.2.0
func (b *ValueBinder) Int8(sourceParam string, dest *int8) *ValueBinder
Int8 binds parameter to int8 variable
func (*ValueBinder) Int8s ¶ added in v4.2.0
func (b *ValueBinder) Int8s(sourceParam string, dest *[]int8) *ValueBinder
Int8s binds parameter to slice of int8
func (*ValueBinder) Ints ¶ added in v4.2.0
func (b *ValueBinder) Ints(sourceParam string, dest *[]int) *ValueBinder
Ints binds parameter to slice of int
func (*ValueBinder) JSONUnmarshaler ¶ added in v4.8.0
func (b *ValueBinder) JSONUnmarshaler(sourceParam string, dest json.Unmarshaler) *ValueBinder
JSONUnmarshaler binds parameter to destination implementing json.Unmarshaler interface
func (*ValueBinder) MustBindUnmarshaler ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.8.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.8.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
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 ¶ added in v4.8.0
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 ¶ added in v4.2.0
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 ¶ added in v4.2.0
func (b *ValueBinder) String(sourceParam string, dest *string) *ValueBinder
String binds parameter to string variable
func (*ValueBinder) Strings ¶ added in v4.2.0
func (b *ValueBinder) Strings(sourceParam string, dest *[]string) *ValueBinder
Strings binds parameter values to slice of string
func (*ValueBinder) TextUnmarshaler ¶ added in v4.8.0
func (b *ValueBinder) TextUnmarshaler(sourceParam string, dest encoding.TextUnmarshaler) *ValueBinder
TextUnmarshaler binds parameter to destination implementing encoding.TextUnmarshaler interface
func (*ValueBinder) Time ¶ added in v4.2.0
func (b *ValueBinder) Time(sourceParam string, dest *time.Time, layout string) *ValueBinder
Time binds parameter to time.Time variable
func (*ValueBinder) Times ¶ added in v4.2.0
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 ¶ added in v4.2.0
func (b *ValueBinder) Uint(sourceParam string, dest *uint) *ValueBinder
Uint binds parameter to uint variable
func (*ValueBinder) Uint16 ¶ added in v4.2.0
func (b *ValueBinder) Uint16(sourceParam string, dest *uint16) *ValueBinder
Uint16 binds parameter to uint16 variable
func (*ValueBinder) Uint16s ¶ added in v4.2.0
func (b *ValueBinder) Uint16s(sourceParam string, dest *[]uint16) *ValueBinder
Uint16s binds parameter to slice of uint16
func (*ValueBinder) Uint32 ¶ added in v4.2.0
func (b *ValueBinder) Uint32(sourceParam string, dest *uint32) *ValueBinder
Uint32 binds parameter to uint32 variable
func (*ValueBinder) Uint32s ¶ added in v4.2.0
func (b *ValueBinder) Uint32s(sourceParam string, dest *[]uint32) *ValueBinder
Uint32s binds parameter to slice of uint32
func (*ValueBinder) Uint64 ¶ added in v4.2.0
func (b *ValueBinder) Uint64(sourceParam string, dest *uint64) *ValueBinder
Uint64 binds parameter to uint64 variable
func (*ValueBinder) Uint64s ¶ added in v4.2.0
func (b *ValueBinder) Uint64s(sourceParam string, dest *[]uint64) *ValueBinder
Uint64s binds parameter to slice of uint64
func (*ValueBinder) Uint8 ¶ added in v4.2.0
func (b *ValueBinder) Uint8(sourceParam string, dest *uint8) *ValueBinder
Uint8 binds parameter to uint8 variable
func (*ValueBinder) Uint8s ¶ added in v4.2.0
func (b *ValueBinder) Uint8s(sourceParam string, dest *[]uint8) *ValueBinder
Uint8s binds parameter to slice of uint8
func (*ValueBinder) Uints ¶ added in v4.2.0
func (b *ValueBinder) Uints(sourceParam string, dest *[]uint) *ValueBinder
Uints binds parameter to slice of uint
func (*ValueBinder) UnixTime ¶ added in v4.2.0
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 ¶ added in v4.8.0
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 ¶ added in v4.2.0
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.