httpwriter

README

http writer

Go http writer package can reply almost any format plus send files as attachment for download.

Documentation

Index

• func ReplyCSS(w http.ResponseWriter, response *Response) (int, error)
• func ReplyFile(w http.ResponseWriter, response *Response) (int, error)
• func ReplyHtml(w http.ResponseWriter, response *Response) (int, error)
• func ReplyJSON(w http.ResponseWriter, response *Response) (int, error)
• func ReplyJavascript(w http.ResponseWriter, response *Response) (int, error)
• func ReplyMsgpack(w http.ResponseWriter, response *Response) (int, error)
• func ReplyProtobuf(w http.ResponseWriter, response *Response) (int, error)
• func ReplyText(w http.ResponseWriter, response *Response) (int, error)
• func ReplyXml(w http.ResponseWriter, response *Response) (int, error)
• func ReplyYaml(w http.ResponseWriter, response *Response) (int, error)
• type Response
  • func NewFileResponse(code int, body interface{}, fileName string) *Response
  • func NewResponse(code int, body interface{}) *Response
• type Writer
  • func NewCSSWriter(w http.ResponseWriter) Writer
  • func NewFileWriter(w http.ResponseWriter) Writer
  • func NewHtmlWriter(w http.ResponseWriter) Writer
  • func NewJavascriptWriter(w http.ResponseWriter) Writer
  • func NewJsonWriter(w http.ResponseWriter) Writer
  • func NewMsgpackWriter(w http.ResponseWriter) Writer
  • func NewProtobufWriter(w http.ResponseWriter) Writer
  • func NewTextWriter(w http.ResponseWriter) Writer
  • func NewXmlWriter(w http.ResponseWriter) Writer
  • func NewYamlWriter(w http.ResponseWriter) Writer

Functions

func ReplyCSS

func ReplyCSS(w http.ResponseWriter, response *Response) (int, error)

ReplyCSS writes a css response

func ReplyFile

func ReplyFile(w http.ResponseWriter, response *Response) (int, error)

ReplyFile writes a file response

func ReplyHtml

func ReplyHtml(w http.ResponseWriter, response *Response) (int, error)

ReplyHtml writes a html response

func ReplyJSON

func ReplyJSON(w http.ResponseWriter, response *Response) (int, error)

ReplyJSON writes a json response

func ReplyJavascript

func ReplyJavascript(w http.ResponseWriter, response *Response) (int, error)

ReplyJavascript writes a javascript response

func ReplyMsgpack

func ReplyMsgpack(w http.ResponseWriter, response *Response) (int, error)

ReplyMsgpack writes a messagepack response

func ReplyProtobuf

func ReplyProtobuf(w http.ResponseWriter, response *Response) (int, error)

ReplyProtobuf writes a javascript response

func ReplyText

func ReplyText(w http.ResponseWriter, response *Response) (int, error)

ReplyText writes a text response

func ReplyXml

func ReplyXml(w http.ResponseWriter, response *Response) (int, error)

ReplyXml writes a xml formatted response

func ReplyYaml

func ReplyYaml(w http.ResponseWriter, response *Response) (int, error)

ReplyYaml writes a yaml response

Types

type Response

type Response struct {
	Code     int
	Body     interface{}
	Filename string
}

Response defines a response code and its body

func NewFileResponse

func NewFileResponse(code int, body interface{}, fileName string) *Response

NewFileResponse return a Response object to send an attachment file for download Note: If sending a file for download as attachment then fileName parameter is to be set as name.extension and body should be the byte content of the file

func NewResponse

func NewResponse(code int, body interface{}) *Response

NewResponse return a Response object

type Writer

type Writer interface {
	http.ResponseWriter
	HeaderWritten() bool
	Status() int
	BytesWritten() int
	Tee(io.Writer)
	Unwrap() http.ResponseWriter
	Reply(response *Response) (int, error)
	Flush()
	Hijack() (net.Conn, *bufio.ReadWriter, error)
	ReadFrom(r io.Reader) (int64, error)
	Push(target string, opts *http.PushOptions) error
}

func NewCSSWriter

func NewCSSWriter(w http.ResponseWriter) Writer

func NewFileWriter

func NewFileWriter(w http.ResponseWriter) Writer

func NewHtmlWriter

func NewHtmlWriter(w http.ResponseWriter) Writer

func NewJavascriptWriter

func NewJavascriptWriter(w http.ResponseWriter) Writer

func NewJsonWriter

func NewJsonWriter(w http.ResponseWriter) Writer

func NewMsgpackWriter

func NewMsgpackWriter(w http.ResponseWriter) Writer

func NewProtobufWriter

func NewProtobufWriter(w http.ResponseWriter) Writer

func NewTextWriter

func NewTextWriter(w http.ResponseWriter) Writer

func NewXmlWriter

func NewXmlWriter(w http.ResponseWriter) Writer

func NewYamlWriter

func NewYamlWriter(w http.ResponseWriter) Writer