render

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Jul 27, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// PrettyIndent indent string for render JSON or XML
	PrettyIndent = "  "

	// FallbackType for auto response
	FallbackType = httpctype.MIMEText
)

Functions

func Auto

func Auto(w http.ResponseWriter, r *http.Request, obj any) (err error)

Auto render data to response

func Blob

func Blob(w http.ResponseWriter, contentType string, data []byte) (err error)

Blob writes out []byte

func HTML

func HTML(w http.ResponseWriter, data string) error

HTML writes out as html text. if data is empty, only write headers

func HTMLBytes

func HTMLBytes(w http.ResponseWriter, data []byte) error

HTMLBytes writes out as html text. if data is empty, only write headers

func JSON

func JSON(w http.ResponseWriter, obj any) error

JSON response rendering

func JSONIndented

func JSONIndented(w http.ResponseWriter, obj any) error

JSONIndented response rendering with indent

func JSONP

func JSONP(callback string, obj any, w http.ResponseWriter) error

JSONP response rendering

func Plain

func Plain(w http.ResponseWriter, str string) error

Plain writes out a string as plain text. alias of the Text()

func Text

func Text(w http.ResponseWriter, str string) error

Text writes out a string as plain text.

func TextBytes

func TextBytes(w http.ResponseWriter, data []byte) error

TextBytes writes out a string as plain text.

func XML

func XML(w http.ResponseWriter, obj any) error

XML response rendering

func XMLPretty

func XMLPretty(w http.ResponseWriter, obj any) error

XMLPretty response rendering with indent

Types

type JSONPRenderer

type JSONPRenderer struct {
	Callback string
}

JSONPRenderer for response JSONP content to client

func (JSONPRenderer) Render

func (r JSONPRenderer) Render(w http.ResponseWriter, obj any) (err error)

Render JSONP to client

type JSONRenderer

type JSONRenderer struct {
	// Data any
	// Indent string for encode
	Indent string
	// NotEscape HTML string
	NotEscape bool
}

JSONRenderer for response JSON content to client

func NewJSONIndented

func NewJSONIndented() JSONRenderer

NewJSONIndented instance

func (JSONRenderer) Render

func (r JSONRenderer) Render(w http.ResponseWriter, obj any) (err error)

Render JSON to client

type Renderer

type Renderer interface {
	Render(w http.ResponseWriter, obj any) error
}

Renderer interface

type RendererFunc

type RendererFunc func(w http.ResponseWriter, obj any) error

RendererFunc definition

func (RendererFunc) Render

func (fn RendererFunc) Render(w http.ResponseWriter, obj any) error

Render to http.ResponseWriter

type ViewRenderer

type ViewRenderer struct {
	TplName string
}

ViewRenderer for response HTML contents to client

func (ViewRenderer) Render

func (r ViewRenderer) Render(w http.ResponseWriter, obj any) (err error)

Render template to client

type XMLRenderer

type XMLRenderer struct {
	// Data any
	Indent string
}

XMLRenderer for response XML content to client

func (XMLRenderer) Render

func (r XMLRenderer) Render(w http.ResponseWriter, obj any) error

Render XML to client

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL