xin

package
v1.0.26 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 20, 2024 License: MIT Imports: 29 Imported by: 17

Documentation

Index

Constants

View Source 
const (
	MIMEJSON              = binding.MIMEJSON
	MIMEHTML              = binding.MIMEHTML
	MIMEXML               = binding.MIMEXML
	MIMEXML2              = binding.MIMEXML2
	MIMEPlain             = binding.MIMEPlain
	MIMEPOSTForm          = binding.MIMEPOSTForm
	MIMEMultipartPOSTForm = binding.MIMEMultipartPOSTForm
)

Content-Type MIME of the most common data formats.

View Source 
const (
	// PlatformGoogleAppEngine when running on Google App Engine. Trust X-Appengine-Remote-Addr
	// for determining the client's IP
	PlatformGoogleAppEngine = "X-Appengine-Remote-Addr"

	// PlatformCloudflare when using Cloudflare's CDN. Trust CF-Connecting-IP for determining
	// the client's IP
	PlatformCloudflare = "CF-Connecting-IP"
)

Trusted platforms

View Source 
const BindKey = "XIN_BIND_KEY"

BindKey indicates a default bind key.

View Source 
const BodyBytesKey = "XIN_BODY_BYTES"

BodyBytesKey indicates a default body bytes key.

View Source 
const ContextKey = "XIN_CONTEXT"

ContextKey is the key that a Context returns itself for.

View Source 
const RequestKey = "XIN_REQUEST"

RequestKey is the key that a Context returns it's Request.

Variables

View Source 
var (
	AnywhereCIDRs = []string{"0.0.0.0/0", "::/0"}
	IntranetCIDRs = []string{"127.0.0.0/8", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16", "::1/32"}
)

CIDRs used by TrustedProxies

Functions

func CreateTestContext 

func CreateTestContext(w http.ResponseWriter) (c *Context, r *Engine)

CreateTestContext returns a fresh engine and context for testing purposes

func Dir 

func Dir(root string, browsable ...bool) http.FileSystem

Dir returns a http.FileSystem that can be used by http.FileServer(). if browsable == true, then it works the same as http.Dir() otherwise it returns a filesystem that prevents http.FileServer() to list the directory files.

func EnableJSONDecoderDisallowUnknownFields 

func EnableJSONDecoderDisallowUnknownFields()

EnableJSONDecoderDisallowUnknownFields sets true for binding.EnableDecoderDisallowUnknownFields to call the DisallowUnknownFields method on the JSON Decoder instance.

func EnableJSONDecoderUseNumber 

func EnableJSONDecoderUseNumber()

EnableJSONDecoderUseNumber sets true for binding.EnableDecoderUseNumber to call the UseNumber method on the JSON Decoder instance.

func FS 

func FS(fsys fs.FS, browsable ...bool) http.FileSystem

FS returns a http.FileSystem that can be used by http.FileServer(). if browsable == true, then it works the same as http.FS() otherwise it returns a filesystem that prevents http.FileServer() to list the directory files.

func FixedModTimeFS 

func FixedModTimeFS(hfs http.FileSystem, mt time.Time) http.FileSystem

FixedModTimeFS returns a FileSystem with fixed ModTime

func IsAjax added in v1.0.26 

func IsAjax(c *Context) bool

IsAjax check http header X-Requested-With == "XMLHttpRequest"

func IsBrokenPipeError 

func IsBrokenPipeError(err any) bool

IsBrokenPipeError Check for a broken connection error

func Next added in v1.0.15 

func Next(c *Context)

Next is a xin.HandlerFunc just call c.Next().

func Recover added in v1.0.10 

func Recover(c *Context, r RecoveryFunc)

func RedirectToSlach 

func RedirectToSlach(c *Context)

RedirectToSlach is a HandlerFunc that redirect to the URL's path + "/" ex: /index?page=1 --> /index/?page=1

func Static added in v1.0.12 

func Static(r IRoutes, relativePath, root string, handlers ...HandlerFunc)

Static serves files from the given file system root. Internally a http.FileServer is used, therefore http.NotFound is used instead of the Router's NotFound handler. example: 

xin.Static(r, "/static", "/var/www", xin.NewCacheControlSetter("public, max-age=31536000").Handler())

func StaticContent added in v1.0.12 

func StaticContent(r IRoutes, relativePath string, data []byte, modtime time.Time, handlers ...HandlerFunc)

StaticContent registers a single route in order to serve a single file of the data. example: 

//go:embed favicon.ico
var favicon []byte
xin.StaticContent(r, "favicon.ico", favicon, time.Now(), xin.NewCacheControlSetter("public, max-age=31536000").Handler())

func StaticFS added in v1.0.12 

func StaticFS(r IRoutes, relativePath string, hfs http.FileSystem, filePath string, handlers ...HandlerFunc)

StaticFS works just like `Static()` but a custom `http.FileSystem` can be used instead.

func StaticFSFile added in v1.0.12 

func StaticFSFile(r IRoutes, relativePath string, hfs http.FileSystem, filePath string, handlers ...HandlerFunc)

StaticFSFile registers a single route in order to serve a single file of the filesystem. xin.StaticFSFile(r, "favicon.ico", hfs, "./resources/favicon.ico", xin.NewCacheControlSetter("public, max-age=31536000").Handler())

func StaticFSFunc added in v1.0.14 

func StaticFSFunc(r IRoutes, relativePath string, hfsc func(c *Context) http.FileSystem, filePath string, handlers ...HandlerFunc)

StaticFSFunc works just like `StaticFS()` but a dynamic `http.FileSystem` can be used instead.

func StaticFSFuncFile added in v1.0.14 

func StaticFSFuncFile(r IRoutes, relativePath string, hfsc func(c *Context) http.FileSystem, filePath string, handlers ...HandlerFunc)

StaticFSFuncFile works just like `StaticFSFile()` but a dynamic `http.FileSystem` can be used instead.

func StaticFile added in v1.0.12 

func StaticFile(r IRoutes, relativePath, filePath string, handlers ...HandlerFunc)

StaticFile registers a single route in order to serve a single file of the local filesystem. example: 

xin.StaticFile(r, "favicon.ico", "./resources/favicon.ico", xin.NewCacheControlSetter("public, max-age=31536000").Handler())

Types

type CacheControlSetter added in v1.0.12 

type CacheControlSetter struct {
	CacheControl string
}

CacheControlSetter set Cache-Control header when statusCode == 200

func NewCacheControlSetter added in v1.0.12 

func NewCacheControlSetter(cacheControls ...string) *CacheControlSetter

func (*CacheControlSetter) Handle added in v1.0.13 

func (ccs *CacheControlSetter) Handle(c *Context)

func (*CacheControlSetter) Handler added in v1.0.13 

func (ccs *CacheControlSetter) Handler() HandlerFunc

func (*CacheControlSetter) SetCacheControl added in v1.0.12 

func (ccs *CacheControlSetter) SetCacheControl(cacheControls ...string)

func (*CacheControlSetter) WrapWriter added in v1.0.12 

func (ccs *CacheControlSetter) WrapWriter(w ResponseWriter) ResponseWriter

type Context 

type Context struct {
	Request *http.Request
	Writer  ResponseWriter

	Params Params

	// locale string for the context of each request.
	Locale string

	// Errors is a list of errors attached to all the handlers/middlewares who used this context.
	Errors []error

	// Accepted defines a list of manually accepted formats for content negotiation.
	Accepted []string

	// Logger
	Logger log.Logger
	// contains filtered or unexported fields
}

Context is the most important part of xin. It allows us to pass variables between middleware, manage the flow, validate the JSON of a request and render a JSON response for example.

func CreateTestContextOnly 

func CreateTestContextOnly(w http.ResponseWriter, r *Engine) (c *Context)

CreateTestContextOnly returns a fresh context base on the engine for testing purposes

func (*Context) Abort 

func (c *Context) Abort()

Abort prevents pending handlers from being called. Note that this will not stop the current handler. Let's say you have an authorization middleware that validates that the current request is authorized. If the authorization fails (ex: the password does not match), call Abort to ensure the remaining handlers for this request are not called.

func (*Context) AbortWithError 

func (c *Context) AbortWithError(code int, err error)

AbortWithError calls `AbortWithStatus()` and `Error()` internally. This method stops the chain, writes the status code and pushes the specified error to `c.Errors`. See Context.Error() for more details.

func (*Context) AbortWithStatus 

func (c *Context) AbortWithStatus(code int)

AbortWithStatus calls `Abort()` and c.String(code, "%d %s", code, http.StatusText(code)). For example, a failed attempt to authenticate a request could use: context.AbortWithStatus(401).

func (*Context) AbortWithStatusJSON 

func (c *Context) AbortWithStatusJSON(code int, jsonObj any)

AbortWithStatusJSON calls `Abort()` and then `JSON` internally. This method stops the chain, writes the status code and return a JSON body. It also sets the Content-Type as "application/json".

func (*Context) AbortWithStatusText added in v1.0.14 

func (c *Context) AbortWithStatusText(code int, format string, values ...any)

AbortWithStatusText calls `Abort()` and then `String` internally. This method stops the chain, writes the status code and return a text body. It also sets the Content-Type as "text/plain".

func (*Context) AddError 

func (c *Context) AddError(err error)

Error attaches an error to the current context. The error is pushed to a list of errors. It's a good idea to call Error for each error that occurred during the resolution of a request. A middleware can be used to collect all the errors and push them to a database together, print a log, or append it in the HTTP response. Error will panic if err is nil.

func (*Context) AddParam 

func (c *Context) AddParam(key, value string)

AddParam adds param to context and replaces path param key with given value for e2e testing purposes Example Route: "/user/:id" AddParam("id", 1) Result: "/user/1"

func (*Context) AsciiJSON 

func (c *Context) AsciiJSON(code int, obj any)

AsciiJSON serializes the given struct as JSON into the response body with unicode to ASCII string. It also sets the Content-Type as "application/json".

func (*Context) Attrs 

func (c *Context) Attrs() map[string]any

Attrs get key/value map exclusively for this context.

func (*Context) Bind 

func (c *Context) Bind(obj any) error

Bind checks the Content-Type to select a binding engine automatically, Depending on the "Content-Type" header different bindings are used: 

"application/json" --> JSON binding
"application/xml"  --> XML binding

otherwise --> returns an error It parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input. It decodes the json payload into the struct specified as a pointer. Like c.Bind() but this method does not set the response status code to 400 and abort if the json is not valid.

func (*Context) BindBodyWith 

func (c *Context) BindBodyWith(obj any, bb binding.BodyBinding) (err error)

BindBodyWith is similar with BindWith, but it stores the request body into the context, and reuse when it is called again.

NOTE: This method reads the body before binding. So you should use BindWith for better performance if you need to call only once.

func (*Context) BindBodyWithJSON added in v1.0.15 

func (c *Context) BindBodyWithJSON(obj any) error

BindBodyWithJSON is a shortcut for c.BindBodyWith(obj, binding.JSON).

func (*Context) BindBodyWithXML added in v1.0.15 

func (c *Context) BindBodyWithXML(obj any) error

BindBodyWithXML is a shortcut for c.BindBodyWith(obj, binding.XML).

func (*Context) BindHeader 

func (c *Context) BindHeader(obj any) error

BindHeader is a shortcut for c.BindWith(obj, binding.Header).

func (*Context) BindJSON 

func (c *Context) BindJSON(obj any) error

BindJSON is a shortcut for c.BindWith(obj, binding.JSON).

func (*Context) BindQuery 

func (c *Context) BindQuery(obj any) error

BindQuery is a shortcut for c.BindWith(obj, binding.Query).

func (*Context) BindURI 

func (c *Context) BindURI(obj any) (err error)

BindURI binds the passed struct pointer using the specified binding engine.

func (*Context) BindWith 

func (c *Context) BindWith(obj any, b binding.Binding) (err error)

BindWith binds the passed struct pointer using the specified binding engine. See the binding package.

func (*Context) BindXML 

func (c *Context) BindXML(obj any) error

BindXML is a shortcut for c.BindWith(obj, binding.XML).

func (*Context) ClientIP 

func (c *Context) ClientIP() string

ClientIP implements one best effort algorithm to return the real client IP. It called c.RemoteIP() under the hood, to check if the remote IP is a trusted proxy or not. If it is it will then try to parse the headers defined in Engine.RemoteIPHeaders (defaulting to [X-Forwarded-For, X-Real-Ip]). If the headers are not syntactically valid OR the remote IP does not correspond to a trusted proxy, the remote IP (coming from Request.RemoteAddr) is returned.

func (*Context) ContentType 

func (c *Context) ContentType() string

ContentType returns the Content-Type header of the request.

func (*Context) Cookie 

func (c *Context) Cookie(name string) (string, error)

Cookie returns the named cookie provided in the request or ErrNoCookie if not found. And return the named cookie is unescaped. If multiple cookies match the given name, only one cookie will be returned.

func (*Context) Copy 

func (c *Context) Copy() *Context

Copy returns a copy of the current context that can be safely used outside the request's scope. This has to be used when the context has to be passed to a goroutine.

func (*Context) CopyUploadedFile added in v1.0.13 

func (c *Context) CopyUploadedFile(file *multipart.FileHeader, dst io.Writer) error

CopyUploadedFile read uploaded file to the specific buffer 'dst'.

func (*Context) Data 

func (c *Context) Data(code int, contentType string, data []byte)

Data writes some data into the body stream and updates the HTTP code.

func (*Context) DataFromReader 

func (c *Context) DataFromReader(code int, contentLength int64, contentType string, reader io.Reader, extraHeaders map[string]string)

DataFromReader writes the specified reader into the body stream and updates the HTTP code.

func (*Context) Deadline 

func (c *Context) Deadline() (deadline time.Time, ok bool)

Deadline returns that there is no deadline (ok==false) when c.Request has no Context.

func (*Context) Del added in v1.0.15 

func (c *Context) Del(key string)

Del is used to delete a stored key/value pair for this context.

func (*Context) Done 

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

Done returns nil (chan which will wait forever) when c.Request has no Context.

func (*Context) Err 

func (c *Context) Err() error

Err returns nil when c.Request has no Context.

func (*Context) File 

func (c *Context) File(filepath string)

File writes the specified file into the body stream in an efficient way.

func (*Context) FileAttachment 

func (c *Context) FileAttachment(filepath, filename string)

FileAttachment writes the specified file into the body stream in an efficient way On the client side, the file will typically be downloaded with the given filename

func (*Context) FileFromFS 

func (c *Context) FileFromFS(filepath string, fs http.FileSystem)

FileFromFS writes the specified file from http.FileSystem into the body stream in an efficient way.

func (*Context) FormFile 

func (c *Context) FormFile(key string) (*multipart.FileHeader, error)

FormFile returns the first file for the provided form key.

func (*Context) FormFiles added in v1.0.12 

func (c *Context) FormFiles(key string) ([]*multipart.FileHeader, error)

FormFiles returns the files for the provided form key.

func (*Context) FullPath 

func (c *Context) FullPath() string

FullPath returns a matched route full path. For not found routes returns an empty string. 

router.GET("/user/:id", func(c *xin.Context) {
    c.FullPath() == "/user/:id" // true
})

func (*Context) Get 

func (c *Context) Get(key string) (value any, exists bool)

Get returns the value for the given key, ie: (value, true). If the value does not exist it returns (nil, false)

func (*Context) GetBool 

func (c *Context) GetBool(key string) (b bool)

GetBool returns the value associated with the key as a boolean.

func (*Context) GetDuration 

func (c *Context) GetDuration(key string) (d time.Duration)

GetDuration returns the value associated with the key as a duration.

func (*Context) GetFloat64 

func (c *Context) GetFloat64(key string) (f64 float64)

GetFloat64 returns the value associated with the key as a float64.

func (*Context) GetHeader 

func (c *Context) GetHeader(key string) string

GetHeader returns value from request headers.

func (*Context) GetInt 

func (c *Context) GetInt(key string) (i int)

GetInt returns the value associated with the key as an integer.

func (*Context) GetInt64 

func (c *Context) GetInt64(key string) (i64 int64)

GetInt64 returns the value associated with the key as an integer.

func (*Context) GetPostForm 

func (c *Context) GetPostForm(key string) (string, bool)

GetPostForm is like PostForm(key). It returns the specified key from a POST urlencoded form or multipart form when it exists `(value, true)` (even when the value is an empty string), otherwise it returns ("", false). For example, during a PATCH request to update the user's email:

email=mail@example.com --> ("mail@example.com", true) := GetPostForm("email") email= --> ("", true) := GetPostForm("email") = --> ("", false) := GetPostForm("email")

func (*Context) GetPostFormArray 

func (c *Context) GetPostFormArray(key string) (values []string, ok bool)

GetPostFormArray returns a slice of strings for a given form key, plus a boolean value whether at least one value exists for the given key.

func (*Context) GetPostFormMap 

func (c *Context) GetPostFormMap(key string) (map[string]string, bool)

GetPostFormMap returns a map for a given form key, plus a boolean value whether at least one value exists for the given key.

func (*Context) GetPostFormMapArray added in v1.0.12 

func (c *Context) GetPostFormMapArray(key string) (map[string][]string, bool)

GetPostFormMapArray returns a map for a given form key, plus a boolean value whether at least one value exists for the given key.

func (*Context) GetQuery 

func (c *Context) GetQuery(key string) (string, bool)

GetQuery is like Query(), it returns the keyed url query value if it exists `(value, true)` (even when the value is an empty string), otherwise it returns `("", false)`. It is shortcut for `c.Request.URL.Query().Get(key)` 

GET /?name=Manu&lastname=
("Manu", true) == c.GetQuery("name")
("", false) == c.GetQuery("id")
("", true) == c.GetQuery("lastname")

func (*Context) GetQueryArray 

func (c *Context) GetQueryArray(key string) (values []string, ok bool)

GetQueryArray returns a slice of strings for a given query key, plus a boolean value whether at least one value exists for the given key.

func (*Context) GetQueryMap 

func (c *Context) GetQueryMap(key string) (map[string]string, bool)

GetQueryMap returns a map for a given query key, plus a boolean value whether at least one value exists for the given key.

func (*Context) GetQueryMapArray added in v1.0.12 

func (c *Context) GetQueryMapArray(key string) (map[string][]string, bool)

GetQueryMapArray returns a map for a given query key, plus a boolean value whether at least one value exists for the given key.

func (*Context) GetRawData 

func (c *Context) GetRawData() ([]byte, error)

GetRawData returns stream data.

func (*Context) GetString 

func (c *Context) GetString(key string) (s string)

GetString returns the value associated with the key as a string.

func (*Context) GetStringMap 

func (c *Context) GetStringMap(key string) (sm map[string]any)

GetStringMap returns the value associated with the key as a map of interfaces.

func (*Context) GetStringMapString 

func (c *Context) GetStringMapString(key string) (sms map[string]string)

GetStringMapString returns the value associated with the key as a map of strings.

func (*Context) GetStringMapStrings added in v1.0.12 

func (c *Context) GetStringMapStrings(key string) (smss map[string][]string)

GetStringMapStrings returns the value associated with the key as a map to a slice of strings.

func (*Context) GetStrings added in v1.0.12 

func (c *Context) GetStrings(key string) (ss []string)

GetStrings returns the value associated with the key as a slice of strings.

func (*Context) GetTime 

func (c *Context) GetTime(key string) (t time.Time)

GetTime returns the value associated with the key as time.

func (*Context) GetUint 

func (c *Context) GetUint(key string) (ui uint)

GetUint returns the value associated with the key as an unsigned integer.

func (*Context) GetUint64 

func (c *Context) GetUint64(key string) (ui64 uint64)

GetUint64 returns the value associated with the key as an unsigned integer.

func (*Context) HTML 

func (c *Context) HTML(code int, name string, obj any)

HTML renders the HTTP template specified by its file name. It also updates the HTTP code and sets the Content-Type as "text/html". See http://golang.org/doc/articles/wiki/

func (*Context) Handler 

func (c *Context) Handler() HandlerFunc

Handler returns the main handler.

func (*Context) HandlerName 

func (c *Context) HandlerName() string

HandlerName returns the main handler's name. For example if the handler is "handleGetUsers()", this function will return "main.handleGetUsers".

func (*Context) HandlerNames 

func (c *Context) HandlerNames() []string

HandlerNames returns a list of all registered handlers for this context in descending order, following the semantics of HandlerName()

func (*Context) Header 

func (c *Context) Header(key, value string)

Header is an intelligent shortcut for c.Writer.Header().Set(key, value). It writes a header in the response. If value == "", this method removes the header `c.Writer.Header().Del(key)`

func (*Context) IndentedJSON 

func (c *Context) IndentedJSON(code int, obj any)

IndentedJSON serializes the given struct as pretty JSON (indented + endlines) into the response body. It also sets the Content-Type as "application/json". WARNING: we recommend using this only for development purposes since printing pretty JSON is more CPU and bandwidth consuming. Use Context.JSON() instead.

func (*Context) IsAborted 

func (c *Context) IsAborted() bool

IsAborted returns true if the current context was aborted.

func (*Context) IsSecure added in v1.0.14 

func (c *Context) IsSecure() bool

IsSecure implements one best effort algorithm to check the https request. It checks the Request.URL.Scheme is 'https' or Request.TLS != nil. It called c.RemoteIP() under the hood, to check if the remote IP is a trusted proxy or not, then checks the SSLProxyHeaders (default "X-Forwarded-Proto": "https") to determine the https request.

func (*Context) IsWebsocket 

func (c *Context) IsWebsocket() bool

IsWebsocket returns true if the request headers indicate that a websocket handshake is being initiated by the client.

func (*Context) JSON 

func (c *Context) JSON(code int, obj any)

JSON serializes the given struct as JSON into the response body. It also sets the Content-Type as "application/json".

func (*Context) JSONP 

func (c *Context) JSONP(code int, obj any)

JSONP serializes the given struct as JSON into the response body. It adds padding to response body to request data from a server residing in a different domain than the client. It also sets the Content-Type as "application/javascript".

func (*Context) MultipartForm 

func (c *Context) MultipartForm() (*multipart.Form, error)

MultipartForm is the parsed multipart form, including file uploads.

func (*Context) MustBind 

func (c *Context) MustBind(obj any) error

MustBind checks the Content-Type to select a binding engine automatically, Depending on the "Content-Type" header different bindings are used: 

"application/json" --> JSON binding
"application/xml"  --> XML binding

otherwise --> returns an error. It parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input. It decodes the json payload into the struct specified as a pointer. It writes a 400 error and sets Content-Type header "text/plain" in the response if input is not valid.

func (*Context) MustBindHeader 

func (c *Context) MustBindHeader(obj any) error

MustBindHeader is a shortcut for c.MustBindWith(obj, binding.Header).

func (*Context) MustBindJSON 

func (c *Context) MustBindJSON(obj any) error

MustBindJSON is a shortcut for c.MustBindWith(obj, binding.JSON).

func (*Context) MustBindQuery 

func (c *Context) MustBindQuery(obj any) error

MustBindQuery is a shortcut for c.MustBindWith(obj, binding.Query).

func (*Context) MustBindURI 

func (c *Context) MustBindURI(obj any) error

MustBindURI binds the passed struct pointer using binding.Uri. It will abort the request with HTTP 400 if any error occurs.

func (*Context) MustBindWith 

func (c *Context) MustBindWith(obj any, b binding.Binding) error

MustBindWith binds the passed struct pointer using the specified binding engine. It will abort the request with HTTP 400 if any error occurs. See the binding package.

func (*Context) MustBindXML 

func (c *Context) MustBindXML(obj any) error

MustBindXML is a shortcut for c.MustBindWith(obj, binding.BindXML).

func (*Context) MustGet 

func (c *Context) MustGet(key string) any

MustGet returns the value for the given key if it exists, otherwise it panics.

func (*Context) Negotiate 

func (c *Context) Negotiate(code int, config Negotiate)

Negotiate calls different Render according to acceptable Accept format.

func (*Context) NegotiateFormat 

func (c *Context) NegotiateFormat(offered ...string) string

NegotiateFormat returns an acceptable Accept format.

func (*Context) Next 

func (c *Context) Next()

Next should be used only inside middleware. It executes the pending handlers in the chain inside the calling handler. See example in GitHub.

func (*Context) Param 

func (c *Context) Param(key string) string

Param returns the value of the URL param. It is a shortcut for c.Params.ByName(key) 

router.GET("/user/:id", func(c *xin.Context) {
    // a GET request to /user/john
    id := c.Param("id") // id == "john"
    // a GET request to /user/john/
    id := c.Param("id") // id == "/john/"
})

func (*Context) PostForm 

func (c *Context) PostForm(key string, defs ...string) string

PostForm returns the specified key from a POST urlencoded form or multipart form when it exists, otherwise it returns the specified defs[0] string or an empty string `("")`.

func (*Context) PostFormArray 

func (c *Context) PostFormArray(key string) (values []string)

PostFormArray returns a slice of strings for a given form key. The length of the slice depends on the number of params with the given key.

func (*Context) PostFormMap 

func (c *Context) PostFormMap(key string) (dict map[string]string)

PostFormMap returns a map for a given form key.

func (*Context) PostFormMapArray added in v1.0.12 

func (c *Context) PostFormMapArray(key string) (dict map[string][]string)

PostFormMapArray returns a map for a given form key.

func (*Context) PostForms added in v1.0.12 

func (c *Context) PostForms() map[string][]string

PostForms returns the POST urlencoded form or multipart form value map

func (*Context) PureJSON 

func (c *Context) PureJSON(code int, obj any)

PureJSON serializes the given struct as JSON into the response body. PureJSON, unlike JSON, does not replace special html characters with their unicode entities.

func (*Context) Query 

func (c *Context) Query(key string, defs ...string) string

Query returns the keyed url query value if it exists, otherwise it returns specified defs[0] string or an empty string `("")`. It is shortcut for `c.Request.URL.Query().Get(key)` 

    GET /path?id=1234&name=Manu&value=
	   c.Query("id") == "1234"
	   c.Query("name") == "Manu"
	   c.Query("value") == ""
	   c.Query("wtf", "none") == "none"

func (*Context) QueryArray 

func (c *Context) QueryArray(key string) (values []string)

QueryArray returns a slice of strings for a given query key. The length of the slice depends on the number of params with the given key.

func (*Context) QueryMap 

func (c *Context) QueryMap(key string) (dict map[string]string)

QueryMap returns a map for a given query key.

func (*Context) QueryMapArray added in v1.0.12 

func (c *Context) QueryMapArray(key string) (dict map[string][]string)

QueryMapArray returns a map for a given query key.

func (*Context) Querys added in v1.0.12 

func (c *Context) Querys() map[string][]string

Querys returns the url query map

func (*Context) ReadUploadedFile added in v1.0.13 

func (c *Context) ReadUploadedFile(file *multipart.FileHeader) ([]byte, error)

ReadUploadedFile read uploaded file and return it's content []byte.

func (*Context) Redirect 

func (c *Context) Redirect(code int, location string)

Redirect returns an HTTP redirect to the specific location.

func (*Context) RemoteIP 

func (c *Context) RemoteIP() string

RemoteIP parses the IP from Request.RemoteAddr, normalizes and returns the IP (without the port).

func (*Context) Render 

func (c *Context) Render(code int, r render.Render)

Render writes the response headers and calls render.Render to render data.

func (*Context) SSEvent 

func (c *Context) SSEvent(name string, message any)

SSEvent writes a Server-Sent Event into the body stream.

func (*Context) SaveUploadedFile 

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

SaveUploadedFile save uploaded file to the specific local file dst.

func (*Context) SecureJSON 

func (c *Context) SecureJSON(code int, obj any)

SecureJSON serializes the given struct as Secure JSON into the response body. Default prepends "while(1)," to response body if the given struct is array values. It also sets the Content-Type as "application/json".

func (*Context) Set 

func (c *Context) Set(key string, value any)

Set is used to store a new key/value pair exclusively for this context. It also lazy initializes c.attrs if it was not used previously.

func (*Context) SetAccepted 

func (c *Context) SetAccepted(formats ...string)

SetAccepted sets Accept header data.

func (*Context) SetAttachmentHeader added in v1.0.10 

func (c *Context) SetAttachmentHeader(filename string)

SetAttachmentHeader set response header Content-Disposition: attachment; filename=...

func (*Context) SetCookie 

func (c *Context) SetCookie(cookie *http.Cookie)

SetCookie adds a Set-Cookie header to the ResponseWriter's headers. The provided cookie must have a valid Name. Invalid cookies may be silently dropped.

func (*Context) Status 

func (c *Context) Status(code int)

Status sets the HTTP response code.

func (*Context) Stream 

func (c *Context) Stream(step func(w io.Writer) bool) bool

Stream sends a streaming response and returns a boolean indicates "Is client disconnected in middle of stream"

func (*Context) String 

func (c *Context) String(code int, format string, values ...any)

String writes the given string into the response body.

func (*Context) Value 

func (c *Context) Value(key any) any

Value returns the value associated with this context for key, or nil if no value is associated with key. Successive calls to Value with the same key returns the same result.

func (*Context) XML 

func (c *Context) XML(code int, obj any)

XML serializes the given struct as XML into the response body. It also sets the Content-Type as "application/xml".

type Engine 

type Engine struct {
	RouterGroup

	// RedirectTrailingSlash enables automatic redirection if the current route can't be matched but a
	// handler for the path with (without) the trailing slash exists.
	// For example if /foo/ is requested but a route only exists for /foo, the
	// client is redirected to /foo with http status code 301 for GET requests
	// and 307 for all other request methods.
	RedirectTrailingSlash bool

	// RedirectFixedPath if enabled, the router tries to fix the current request path, if no
	// handle is registered for it.
	// First superfluous path elements like ../ or // are removed.
	// Afterwards the router does a case-insensitive lookup of the cleaned path.
	// If a handle can be found for this route, the router makes a redirection
	// to the corrected path with status code 301 for GET requests and 307 for
	// all other request methods.
	// For example /FOO and /..//Foo could be redirected to /foo.
	// RedirectTrailingSlash is independent of this option.
	RedirectFixedPath bool

	// HandleMethodNotAllowed if enabled, the router checks if another method is allowed for the
	// current route, if the current request can not be routed.
	// If this is the case, the request is answered with 'Method Not Allowed'
	// and HTTP status code 405.
	// If no other Method is allowed, the request is delegated to the NotFound
	// handler.
	HandleMethodNotAllowed bool

	// UseRawPath if enabled, the url.RawPath will be used to find parameters.
	UseRawPath bool

	// UnescapePathValues if true, the path value will be unescaped.
	// If UseRawPath is false (by default), the UnescapePathValues effectively is true,
	// as url.Path gonna be used, which is already unescaped.
	UnescapePathValues bool

	// RemoveExtraSlash a parameter can be parsed from the URL even with extra slashes.
	// See the PR #1817 and issue #1644
	RemoveExtraSlash bool

	// RemoteIPHeaders list of headers used to obtain the client IP when
	// `(*xin.Context).Request.RemoteAddr` is matched by at least one of the
	// network origins of list defined by `(*xin.Engine).SetTrustedProxies()`.
	RemoteIPHeaders []string

	// TrustedIPHeader if set to a constant of value xin.Platform*, trusts the headers set by
	// that platform to determine the client IP
	TrustedIPHeader string

	// SSLProxyHeaders is set of header keys with associated values that would indicate a valid https request.
	// Useful when behind a Proxy Server (Apache, Nginx).
	// Default is `map[string]string{"X-Forwarded-Proto": "https"}`.
	SSLProxyHeaders map[string]string

	// MaxMultipartMemory value of 'maxMemory' param that is given to http.Request's ParseMultipartForm
	// method call.
	MaxMultipartMemory int64

	// ContextWithFallback enable fallback Context.Deadline(), Context.Done(), Context.Err() and Context.Value() when Context.Request.Context() is not nil.
	ContextWithFallback bool

	// HTMLTemplates html templates
	HTMLTemplates render.HTMLTemplates

	// Validator struct validator
	Validator validate.StructValidator

	// Logger
	Logger log.Logger
	// contains filtered or unexported fields
}

Engine is the framework's instance, it contains the muxer, middleware and configuration settings. Create an instance of Engine, by using New() or Default()

func Default 

func Default() *Engine

Default returns an Engine instance with the Recovery middleware already attached.

func New 

func New() *Engine

New returns a new blank Engine instance without any middleware attached. By default, the configuration is: - RedirectTrailingSlash: true - RedirectFixedPath: false - HandleMethodNotAllowed: false - ForwardedByClientIP: true - UseRawPath: false - UnescapePathValues: true

func (*Engine) HandleContext 

func (engine *Engine) HandleContext(c *Context)

HandleContext re-enters a context that has been rewritten. This can be done by setting c.Request.URL.Path to your new target. Disclaimer: You can loop yourself to deal with this, use wisely.

func (*Engine) NoMethod 

func (engine *Engine) NoMethod(handlers ...HandlerFunc)

NoMethod sets the handlers called when Engine.HandleMethodNotAllowed = true.

func (*Engine) NoRoute 

func (engine *Engine) NoRoute(handlers ...HandlerFunc)

NoRoute adds handlers for NoRoute. It returns a 404 code by default.

func (*Engine) Routes 

func (engine *Engine) Routes() (routes RoutesInfo)

Routes returns a slice of registered routes, including some useful information, such as: the http method, path and the handler name.

func (*Engine) SecureJSONPrefix 

func (engine *Engine) SecureJSONPrefix(prefix string) *Engine

SecureJSONPrefix sets the secureJSONPrefix used in Context.SecureJSON. Prefixing the JSON string in this manner is used to help prevent JSON Hijacking. The prefix renders the string syntactically invalid as a script so that it cannot be hijacked. This prefix should be stripped before parsing the string as JSON. The default prefix is ")]}',\n".

func (*Engine) ServeHTTP 

func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP conforms to the http.Handler interface.

func (*Engine) SetTrustedProxies 

func (engine *Engine) SetTrustedProxies(trustedProxies []string) error

SetTrustedProxies set a list of network origins (IPv4 addresses, IPv4 CIDRs, IPv6 addresses or IPv6 CIDRs) from which to trust request's headers that contain alternative client IP when `(*xin.Engine).ForwardedByClientIP` is `true`. `TrustedProxies` feature is enabled by default, and it also trusts all proxies by default. If you want to disable this feature, use Engine.SetTrustedProxies(nil), then Context.ClientIP() will return the remote address directly.

func (*Engine) Use 

func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes

Use attaches a global middleware to the router. i.e. the middleware attached through Use() will be included in the handlers chain for every single request. Even 404, 405, static files... For example, this is the right place for a logger or error management middleware.

type H 

type H map[string]any

H is a shortcut for map[string]any

func (H) MarshalXML 

func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML allows type H to be used with xml.Marshal.

type HandlerFunc 

type HandlerFunc func(*Context)

HandlerFunc defines the handler used by xin middleware as return value.

func CustomRecovery added in v1.0.10 

func CustomRecovery(r RecoveryFunc) HandlerFunc

CustomRecovery returns a middleware that recovers from any panics and calls the provided handle func to handle it.

func MustBind 

func MustBind(val any) HandlerFunc

MustBind is a helper function for given interface object and returns a Xin middleware.

func Recovery 

func Recovery() HandlerFunc

Recovery returns a middleware that recovers from any panics and writes a 500 if there was one.

func Redirector 

func Redirector(url string, codes ...int) HandlerFunc

Redirector is a HandlerFunc that redirect to the url with http status codes[0] or http.StatusFound

func ServeContentHandler added in v1.0.13 

func ServeContentHandler(data []byte, modtime time.Time) HandlerFunc

func ServeFSFileHandler added in v1.0.12 

func ServeFSFileHandler(hfs http.FileSystem, filePath string) HandlerFunc

func ServeFSFuncFileHandler added in v1.0.14 

func ServeFSFuncFileHandler(hfsc func(c *Context) http.FileSystem, filePath string) HandlerFunc

func ServeFSFuncHandler added in v1.0.14 

func ServeFSFuncHandler(prefix string, hfsc func(c *Context) http.FileSystem, filePath string) HandlerFunc

func ServeFSHandler added in v1.0.13 

func ServeFSHandler(prefix string, hfs http.FileSystem, filePath string) HandlerFunc

func ServeFileHandler added in v1.0.12 

func ServeFileHandler(filePath string) HandlerFunc

func WrapF 

func WrapF(f http.HandlerFunc) HandlerFunc

WrapF is a helper function for wrapping http.HandlerFunc and returns a Xin middleware.

func WrapH 

func WrapH(h http.Handler) HandlerFunc

WrapH is a helper function for wrapping http.Handler and returns a Xin middleware.

type HandlersChain 

type HandlersChain []HandlerFunc

HandlersChain defines a HandlerFunc slice.

func (HandlersChain) Last 

func (c HandlersChain) Last() HandlerFunc

Last returns the last handler in the chain. i.e. the last handler is the main one.

type IRouter 

type IRouter interface {
	IRoutes
	Group(string, ...HandlerFunc) *RouterGroup
}

IRouter defines all router handle interface includes single and group router.

type IRoutes 

type IRoutes interface {
	BasePath() string

	Use(...HandlerFunc) IRoutes

	Handle(string, string, ...HandlerFunc) IRoutes
	Any(string, ...HandlerFunc) IRoutes
	GET(string, ...HandlerFunc) IRoutes
	POST(string, ...HandlerFunc) IRoutes
	DELETE(string, ...HandlerFunc) IRoutes
	PATCH(string, ...HandlerFunc) IRoutes
	PUT(string, ...HandlerFunc) IRoutes
	OPTIONS(string, ...HandlerFunc) IRoutes
	HEAD(string, ...HandlerFunc) IRoutes
}

IRoutes defines all router handle interface.

type Negotiate 

type Negotiate struct {
	Offered  []string
	HTMLName string
	HTMLData any
	JSONData any
	XMLData  any
	Data     any
}

Negotiate contains all negotiations data.

type Param 

type Param struct {
	Key   string
	Value string
}

Param is a single URL parameter, consisting of a key and a value.

type Params 

type Params []Param

Params is a Param-slice, as returned by the router. The slice is ordered, the first URL parameter is also the first slice value. It is therefore safe to read values by the index.

func (Params) ByName 

func (ps Params) ByName(name string) (va string)

ByName returns the value of the first Param which key matches the given name. If no matching Param is found, an empty string is returned.

func (Params) Get 

func (ps Params) Get(name string) (string, bool)

Get returns the value of the first Param which key matches the given name and a boolean true. If no matching Param is found, an empty string is returned and a boolean false .

type RecoveryFunc added in v1.0.10 

type RecoveryFunc func(c *Context, err any)

RecoveryFunc defines the function passable to CustomRecovery.

type ResponseWriter 

type ResponseWriter interface {
	http.ResponseWriter
	http.Hijacker
	http.Flusher
	http.CloseNotifier

	// Status returns the HTTP response status code of the current request.
	Status() int

	// Size returns the number of bytes already written into the response http body.
	// See Written()
	Size() int

	// WriteString writes the string into the response body.
	WriteString(string) (int, error)

	// Written returns true if the response body was already written.
	Written() bool

	// WriteHeaderNow forces to write the http header (status code + headers).
	WriteHeaderNow()

	// Pusher get the http.Pusher for server push
	Pusher() http.Pusher
}

ResponseWriter ...

func NewHeaderWriter added in v1.0.13 

func NewHeaderWriter(w ResponseWriter, key, value string) ResponseWriter

NewHeaderWriter create a ResponseWriter to append on WriteHeader(statusCode int). if statusCode != 200, header will not append. a existing header will not be overwriten.

func NewHeadersWriter added in v1.0.13 

func NewHeadersWriter(w ResponseWriter, h map[string]string) ResponseWriter

NewHeadersWriter create a ResponseWriter to append on WriteHeader(statusCode int). if statusCode != 200, header will not append. a existing header will not be overwriten.

type RouteInfo 

type RouteInfo struct {
	Method      string
	Path        string
	Handler     string
	HandlerFunc HandlerFunc
}

RouteInfo represents a request route's specification which contains method and path and its handler.

type RouterGroup 

type RouterGroup struct {
	Handlers HandlersChain
	// contains filtered or unexported fields
}

RouterGroup is used internally to configure router, a RouterGroup is associated with a prefix and an array of handlers (middleware).

func (*RouterGroup) Any 

func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) IRoutes

Any registers a route that matches all the HTTP methods. GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE, CONNECT, TRACE.

func (*RouterGroup) BasePath 

func (group *RouterGroup) BasePath() string

BasePath returns the base path of router group. For example, if v := router.Group("/rest/n/v1/api"), v.BasePath() is "/rest/n/v1/api".

func (*RouterGroup) DELETE 

func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) IRoutes

DELETE is a shortcut for router.Handle("DELETE", path, handlers).

func (*RouterGroup) GET 

func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) IRoutes

GET is a shortcut for router.Handle("GET", path, handlers).

func (*RouterGroup) Group 

func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

Group creates a new router group. You should add all the routes that have common middlewares or the same path prefix. For example, all the routes that use a common middleware for authorization could be grouped.

func (*RouterGroup) HEAD 

func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) IRoutes

HEAD is a shortcut for router.Handle("HEAD", path, handlers).

func (*RouterGroup) Handle 

func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) IRoutes

Handle registers a new request handle and middleware with the given path and method. The last handler should be the real handler, the other ones should be middleware that can and should be shared among different routes. See the example code in GitHub.

For GET, POST, PUT, PATCH and DELETE requests the respective shortcut functions can be used.

This function is intended for bulk loading and to allow the usage of less frequently used, non-standardized or custom methods (e.g. for internal communication with a proxy).

func (*RouterGroup) OPTIONS 

func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) IRoutes

OPTIONS is a shortcut for router.Handle("OPTIONS", path, handlers).

func (*RouterGroup) PATCH 

func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) IRoutes

PATCH is a shortcut for router.Handle("PATCH", path, handlers).

func (*RouterGroup) POST 

func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) IRoutes

POST is a shortcut for router.Handle("POST", path, handlers).

func (*RouterGroup) PUT 

func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) IRoutes

PUT is a shortcut for router.Handle("PUT", path, handlers).

func (*RouterGroup) Use 

func (group *RouterGroup) Use(middleware ...HandlerFunc) IRoutes

Use adds middleware to the group, see example code in GitHub.

type RoutesInfo 

type RoutesInfo []RouteInfo

RoutesInfo defines a RouteInfo slice.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.