response

Documentation

Overview

Package response provides wrapper for http.response.

Index

• type BufferWriter
  • func NewBufferWriter(writer http.ResponseWriter) *BufferWriter
  • func (w *BufferWriter) Buffer() []byte
  • func (w *BufferWriter) BufferLength() int
  • func (w *BufferWriter) BufferString() string
  • func (w *BufferWriter) ClearBuffer()
  • func (w *BufferWriter) Flush()
  • func (w *BufferWriter) RawWriter() http.ResponseWriter
  • func (w *BufferWriter) SetBuffer(data []byte)
  • func (w *BufferWriter) Write(data []byte) (int, error)
  • func (w *BufferWriter) WriteHeader(status int)
  • func (w *BufferWriter) WriteString(data string) (int, error)
• type Writer
  • func NewWriter(writer http.ResponseWriter) *Writer
  • func (w *Writer) BytesWritten() int64
  • func (w *Writer) Flush()
  • func (w *Writer) Hijack() (conn net.Conn, writer *bufio.ReadWriter, err error)
  • func (w *Writer) IsHeaderWrote() bool
  • func (w *Writer) IsHijacked() bool
  • func (w *Writer) Write(data []byte) (int, error)
  • func (w *Writer) WriteHeader(status int)

Types

type BufferWriter

type BufferWriter struct {
	*Writer     // The underlying BufferWriter.
	Status  int // HTTP status.
	// contains filtered or unexported fields
}

BufferWriter is the custom writer for http response with buffer.

func NewBufferWriter

func NewBufferWriter(writer http.ResponseWriter) *BufferWriter

func (*BufferWriter) Buffer

func (w *BufferWriter) Buffer() []byte

Buffer returns the buffered content as []byte.

func (*BufferWriter) BufferLength

func (w *BufferWriter) BufferLength() int

BufferLength returns the length of the buffered content.

func (*BufferWriter) BufferString

func (w *BufferWriter) BufferString() string

BufferString returns the buffered content as string.

func (*BufferWriter) ClearBuffer

func (w *BufferWriter) ClearBuffer()

ClearBuffer clears the response buffer.

func (*BufferWriter) Flush

func (w *BufferWriter) Flush()

Flush outputs the buffer to clients and clears the buffer.

func (*BufferWriter) RawWriter

func (w *BufferWriter) RawWriter() http.ResponseWriter

RawWriter returns the underlying BufferWriter.

func (*BufferWriter) SetBuffer

func (w *BufferWriter) SetBuffer(data []byte)

SetBuffer overwrites the buffer with `data`.

func (*BufferWriter) Write

func (w *BufferWriter) Write(data []byte) (int, error)

Write implements the interface function of http.BufferWriter.Write.

func (*BufferWriter) WriteHeader

func (w *BufferWriter) WriteHeader(status int)

WriteHeader implements the interface of http.BufferWriter.WriteHeader.

func (*BufferWriter) WriteString

func (w *BufferWriter) WriteString(data string) (int, error)

WriteString writes string content to internal buffer.

type Writer

type Writer struct {
	http.ResponseWriter // The underlying ResponseWriter.
	// contains filtered or unexported fields
}

Writer wraps http.ResponseWriter for extra features.

func NewWriter

func NewWriter(writer http.ResponseWriter) *Writer

NewWriter creates and returns a new Writer.

func (*Writer) BytesWritten

func (w *Writer) BytesWritten() int64

BytesWritten returns the length that was written to response.

func (*Writer) Flush

func (w *Writer) Flush()

Flush sends any buffered data to the client.

func (*Writer) Hijack

func (w *Writer) Hijack() (conn net.Conn, writer *bufio.ReadWriter, err error)

Hijack implements the interface function of http.Hijacker.Hijack.

func (*Writer) IsHeaderWrote

func (w *Writer) IsHeaderWrote() bool

IsHeaderWrote returns if the header status is written.

func (*Writer) IsHijacked

func (w *Writer) IsHijacked() bool

IsHijacked returns if the connection is hijacked.

func (*Writer) Write

func (w *Writer) Write(data []byte) (int, error)

Write implements the interface function of http.ResponseWriter.Write.

func (*Writer) WriteHeader

func (w *Writer) WriteHeader(status int)

WriteHeader implements the interface of http.ResponseWriter.WriteHeader. Note that the underlying `WriteHeader` can only be called once in a http response.