The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- Variables
- func AddHeader(w http.ResponseWriter, name, value string)
- func GetHost[T RequestConstraint](r T) string
- type CSRFToken
- type JSONResponse
- type Logger
- type Message
- type Messages
- type Request
- func (r *Request) AddHeader(name, value string)
- func (r *Request) DeleteCookie(name string)
- func (r *Request) Error(code int, err string)
- func (r *Request) Form() url.Values
- func (r *Request) FormFileBuffer(name string) (*bytes.Buffer, error)
- func (r *Request) GetCookie(name string) (*http.Cookie, error)
- func (r *Request) GetData(key string) interface{}
- func (r *Request) GetHeader(name string) string
- func (r *Request) IP() string
- func (r *Request) Method() string
- func (r *Request) Next() string
- func (r *Request) Redirect(redirectURL string, statuscode int, next ...string)
- func (r *Request) Render(templateName string) error
- func (r *Request) RenderString(templateString string) error
- func (r *Request) RenderTemplate(t *template.Template, name string) error
- func (r *Request) SetCookies(cookies ...*http.Cookie)
- func (r *Request) SetData(key string, value interface{})
- func (r *Request) SetHeader(name, value string)
- func (r *Request) Write(b []byte) (int, error)
- func (r *Request) WriteString(s string) (int, error)
- type RequestConstraint
- type ResponseStatus
- type Session
- type TemplateData
- func (td *TemplateData) AddMessage(messageType, message string)
- func (td *TemplateData) Delete(key string)
- func (td *TemplateData) Get(key string) interface{}
- func (td *TemplateData) Has(key string) bool
- func (td *TemplateData) Set(key string, value interface{})
- func (td *TemplateData) URL(path string, args ...interface{}) string
- type URLParams
- type User
Constants ¶
const MESSAGE_COOKIE_NAME = "messages"
const NEXT_COOKIE_NAME = "next"
Variables ¶
var DEFAULT_DATA_FUNC func(r *Request)
var TEMPLATE_MANAGER *templates.Manager
Functions ¶
func AddHeader ¶ added in v2.6.3
func AddHeader(w http.ResponseWriter, name, value string)
Add a header onto the request. This will append the value to the current value. If the value already exists, it will not be added.
func GetHost ¶
func GetHost[T RequestConstraint](r T) string
Types ¶
type CSRFToken ¶ added in v2.1.4
type CSRFToken struct {
Token string
}
func NewCSRFToken ¶ added in v2.1.4
type JSONResponse ¶
type JSONResponse struct {
Next string `json:"next,omitempty"`
Detail string `json:"detail,omitempty"`
Status ResponseStatus `json:"status"`
Data interface{} `json:"data"`
}
Default json response which gets returned when using (j).Encode().
type Logger ¶ added in v2.5.4
type Logger interface {
// Write a critical error message
// This message should be handled differently
// than the other ways of reporting.
Critical(err error)
// Write an error message, loglevel error
Error(args ...any)
Errorf(format string, args ...any)
// Write a warning message, loglevel warning
Warning(args ...any)
Warningf(format string, args ...any)
// Write an info message, loglevel info
Info(args ...any)
Infof(format string, args ...any)
// Write a debug message, loglevel debug
Debug(args ...any)
Debugf(format string, args ...any)
// Write a test message, loglevel test
Test(args ...any)
Testf(format string, args ...any)
}
Default logger interface, can be used to set a logger on the request. This logger can be set in for example, the middleware, and then be used in the views by the request.
type Request ¶
type Request struct {
// Underlying http response writer.
Response http.ResponseWriter
// Underlying http request.
Request *http.Request
// Default data to be passed to any possible templates.
Data *TemplateData
// URL Parameters set inside of the router.
URLParams URLParams
// The request JSON object, which handles returning json responses.
// This is mostly for semantic reasons.
JSON *_json
// Interfaces which can be set using the right middlewares.
// These interfaces are not set by default, but can be set by middleware.
User User
Session Session
Logger Logger
URL func(method, name string) routevars.URLFormatter
// contains filtered or unexported fields
}
Default request to be passed around the router.
func NewRequest ¶
Initialize a new request.
func (*Request) DeleteCookie ¶ added in v2.5.1
Delete cookies.
func (*Request) FormFileBuffer ¶
Get a form file as a buffer.
func (*Request) Next ¶ added in v2.4.4
Get the Next url. This is the url that was set in the session/cookies. This is used to redirect back to the same page.
func (*Request) Redirect ¶ added in v2.4.4
Redirect to a URL. If the session is defined, the messages will be set in the session. If the `next` argument is given, it will be added to session, unless the session is not defined, the `next` parameter will be added to cookies. This means they will be carried across when rendering with request.Render(). This will be set again after the redirect, when rendering in the default Data. Optionally you could obtain this by calling request.Next().
func (*Request) Render ¶ added in v2.3.2
Template configuration must be set before calling this function! See the templates package for more information.
func (*Request) RenderString ¶ added in v2.9.0
Render a string as a template
func (*Request) RenderTemplate ¶ added in v2.9.1
Render a template with the given name
func (*Request) SetCookies ¶ added in v2.5.1
Set cookies.
type RequestConstraint ¶
This constraint is used to retrieve the request host.
type ResponseStatus ¶
type ResponseStatus string
const ( ResponseStatusOK ResponseStatus = "ok" ResponseStatusError ResponseStatus = "error" ResponseStatusRedirect ResponseStatus = "redirect" )
type Session ¶ added in v2.3.6
type Session interface {
Set(key string, value interface{})
Get(key string) interface{}
Exists(key string) bool
Delete(key string)
Destroy() error
RenewToken() error
}
This interface will be set on the request, but is only useful if any middleware is using it. If no middleware has set it, it will remain unused.
type TemplateData ¶ added in v2.1.4
type TemplateData struct {
Data map[string]any
Messages Messages
CSRFToken *CSRFToken
User interface{}
Next string
// contains filtered or unexported fields
}
func NewTemplateData ¶ added in v2.1.4
func NewTemplateData() *TemplateData
func (*TemplateData) AddMessage ¶ added in v2.1.4
func (td *TemplateData) AddMessage(messageType, message string)
func (*TemplateData) Delete ¶ added in v2.1.4
func (td *TemplateData) Delete(key string)
func (*TemplateData) Get ¶ added in v2.1.4
func (td *TemplateData) Get(key string) interface{}
func (*TemplateData) Has ¶ added in v2.1.4
func (td *TemplateData) Has(key string) bool
func (*TemplateData) Set ¶ added in v2.1.4
func (td *TemplateData) Set(key string, value interface{})
func (*TemplateData) URL ¶ added in v2.9.8
func (td *TemplateData) URL(path string, args ...interface{}) string
type User ¶ added in v2.0.1
type User interface {
// Check if the user is authenticated
IsAuthenticated() bool
// Check if the user is an administator
IsAdmin() bool
}
Default request user interface. This interface is used to check if a user is authenticated. This interface is used by the LoginRequiredMiddleware and LogoutRequiredMiddleware. If you want to use these middlewares, you should implement this interface. And set the GetRequestUserFunc function to return a user.
Source Files