context

Documentation

Index

• type IContext
• type IContextBinder
• type IContextRenderer
• type IContextRequest
• type IContextResponse
• type IContextStorage

Types

type IContext

type IContext interface {
	context.Context
	IContextRenderer
	IContextStorage
	IContextBinder
	IContextRequest
	IContextResponse

	Reset(*fasthttp.RequestCtx)
	GetRequestCtx() *fasthttp.RequestCtx
	Clone() IContext
	Do()
	Next()
	StopExecution()
	IsStopped() bool
	GetHandlerName() string
}

IContext the interface for the Context

type IContextBinder

type IContextBinder interface {
	ReadJSON(interface{}) error
	ReadXML(interface{}) error
	ReadForm(formObject interface{}) error
}

IContextBinder is part of the IContext

type IContextRenderer

type IContextRenderer interface {
	Write(string, ...interface{})
	WriteHTML(int, string)
	// Data writes out the raw bytes as binary data.
	Data(status int, v []byte) error
	// HTML builds up the response from the specified template and bindings.
	HTML(status int, name string, binding interface{}, layout ...string) error
	// Render same as .HTML but with status to iris.StatusOK (200)
	Render(name string, binding interface{}, layout ...string) error
	// JSON marshals the given interface object and writes the JSON response.
	JSON(status int, v interface{}) error
	// JSONP marshals the given interface object and writes the JSON response.
	JSONP(status int, callback string, v interface{}) error
	// Text writes out a string as plain text.
	Text(status int, v string) error
	// XML marshals the given interface object and writes the XML response.
	XML(status int, v interface{}) error

	ExecuteTemplate(*template.Template, interface{}) error
	ServeContent(io.ReadSeeker, string, time.Time, bool) error
	ServeFile(string, bool) error
	SendFile(filename string, destinationName string) error
	Stream(func(*bufio.Writer))
	StreamWriter(cb func(writer *bufio.Writer))
	StreamReader(io.Reader, int)
}

IContextRenderer is part of the IContext

type IContextRequest

type IContextRequest interface {
	Param(string) string
	ParamInt(string) (int, error)
	URLParam(string) string
	URLParamInt(string) (int, error)
	URLParams() map[string]string
	MethodString() string
	HostString() string
	PathString() string
	RequestIP() string
	RemoteAddr() string
	RequestHeader(k string) string
	PostFormValue(string) string
}

IContextRequest is part of the IContext

type IContextResponse

type IContextResponse interface {
	// SetStatusCode sets the http status code
	SetStatusCode(int)
	// SetContentType sets the "Content-Type" header, receives the value
	SetContentType(string)
	// SetHeader sets the response headers first parameter is the key, second is the value
	SetHeader(string, string)
	Redirect(string, ...int)
	// Errors
	NotFound()
	Panic()
	EmitError(int)
}

IContextResponse is part of the IContext

type IContextStorage

type IContextStorage interface {
	Get(string) interface{}
	GetString(string) string
	GetInt(string) int
	Set(string, interface{})
	SetCookie(*fasthttp.Cookie)
	SetCookieKV(string, string)
	RemoveCookie(string)
	// Flash messages
	GetFlash(string) string
	GetFlashBytes(string) ([]byte, error)
	SetFlash(string, string)
	SetFlashBytes(string, []byte)
	Session() store.IStore
	SessionDestroy()
}

IContextStorage is part of the IContext