response

Documentation

Index

• func Bytes(ctype string, data []byte, opts ...Option) (*router.Response, error)
• func HTML(fstr string, data interface{}, opts ...Option) (*router.Response, error)
• func JSON(body interface{}, opts ...Option) *router.Response
• func Reader(ctype string, rdr io.Reader, opts ...Option) (*router.Response, error)
• func Redirect(dest string, opts ...Option) *router.Response
• func Success(body interface{}, opts ...Option) *router.Response
• func Text(ctype, text string, opts ...Option) (*router.Response, error)
• type Config
  • func (c Config) WithOptions(opts []Option) Config
• type Option
  • func WithFuncs(f template.FuncMap) Option
  • func WithHeader(k, v string) Option
  • func WithHeaders(h map[string]string) Option
  • func WithStatus(s int) Option

Functions

func Bytes

func Bytes(ctype string, data []byte, opts ...Option) (*router.Response, error)

Produce a successful response with a byte entity. The status code used is 200 unless otherwise specified via an option.

func HTML

func HTML(fstr string, data interface{}, opts ...Option) (*router.Response, error)

Produce a successful 200 response with HTML entity content. The template string is expected to use the Go template (HTML variant) format, and it will be evaluated with the provided context value. The result of this evaluation is the response entity.

func JSON

func JSON(body interface{}, opts ...Option) *router.Response

Produce a successful response, optionally including a payload, which will be marshaled to JSON. The status code used is 200 unless otherwise specified via an option.

func Reader

func Reader(ctype string, rdr io.Reader, opts ...Option) (*router.Response, error)

Produce a successful response with a reader entity. The status code used is 200 unless otherwise specified via an option.

func Redirect

func Redirect(dest string, opts ...Option) *router.Response

Produce a 302/Found redirect response

func Success

func Success(body interface{}, opts ...Option) *router.Response

Produce a successful response, optionally including a payload, which will be marshaled to JSON. The status code used is 200 unless otherwise specified via an option.

Deprecated: This method has been deprecated in favor of JSON(), which it simply calls.

func Text

func Text(ctype, text string, opts ...Option) (*router.Response, error)

Produce a successful response with a text entity. The status code used is 200 unless otherwise specified via an option.

Types

type Config

type Config struct {
	Status int
	Header http.Header
	Funcs  template.FuncMap
}

func (Config) WithOptions

func (c Config) WithOptions(opts []Option) Config

type Option

type Option func(Config) Config

func WithFuncs

func WithFuncs(f template.FuncMap) Option

func WithHeader

func WithHeader(k, v string) Option

func WithHeaders

func WithHeaders(h map[string]string) Option

func WithStatus

func WithStatus(s int) Option