response

Documentation

Index

• func NewJSONEncoder() middleware.Middleware
• func WithError(ctx context.Context, err Error)
• func WithPayload(ctx context.Context, payload interface{})
• type Buffer
  • func NewBuffer(w http.ResponseWriter) *Buffer
  • func (w *Buffer) Flush()
  • func (w *Buffer) Header() http.Header
  • func (w *Buffer) Write(buf []byte) (int, error)
  • func (w *Buffer) WriteHeader(status int)
• type Error
  • func (e Error) MarshalJSON() ([]byte, error)

Functions

func NewJSONEncoder

func NewJSONEncoder() middleware.Middleware

NewJSONEncoder creates a new response middleware

func WithError

func WithError(ctx context.Context, err Error)

WithError add an Error struct to the given context

func WithPayload

func WithPayload(ctx context.Context, payload interface{})

WithPayload adds payload to the given context

Types

type Buffer

type Buffer struct {
	Response http.ResponseWriter
	Status   int
	Body     *bytes.Buffer
}

Buffer implements ResponseWriter interface and can be used to collect the response body in a middleware handlers.

func NewBuffer

func NewBuffer(w http.ResponseWriter) *Buffer

NewBuffer create a new response buffer

func (*Buffer) Flush

func (w *Buffer) Flush()

Flush implements the Flusher interface

func (*Buffer) Header

func (w *Buffer) Header() http.Header

Header returns the response header handle.

func (*Buffer) Write

func (w *Buffer) Write(buf []byte) (int, error)

Write buffers the response.

func (*Buffer) WriteHeader

func (w *Buffer) WriteHeader(status int)

WriteHeader stores the status code

type Error

type Error struct {
	Code    int    `json:"code"`
	Error   error  `json:"error"`
	Message string `json:"message"`
}

Error is a struct to store a JSON error representation

func (Error) MarshalJSON

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON is the implementation of Marshaler interface for Error