herodot

Documentation

Index

• Constants
• Variables
• func Context(ctx context.Context) context.Context
• func NewContext() context.Context
• type Error
  • func ToError(err error) *Error
  • func (e Error) Error() string
• type Herodot
• type JSON
  • func (h *JSON) Write(ctx context.Context, w http.ResponseWriter, r *http.Request, e interface{})
  • func (h *JSON) WriteCode(ctx context.Context, w http.ResponseWriter, r *http.Request, code int, ...)
  • func (h *JSON) WriteCreated(ctx context.Context, w http.ResponseWriter, r *http.Request, location string, ...)
  • func (h *JSON) WriteError(ctx context.Context, w http.ResponseWriter, r *http.Request, err error)
  • func (h *JSON) WriteErrorCode(ctx context.Context, w http.ResponseWriter, r *http.Request, code int, ...)

Constants

const RequestIDKey key = 0

Variables

var (
	ErrNotFound = &Error{
		Err:  errors.New("Not found"),
		Code: http.StatusNotFound,
	}
	ErrUnauthorized = &Error{
		Err:  errors.New("Unauthorized"),
		Code: http.StatusUnauthorized,
	}
	ErrBadRequest = &Error{
		Err:  errors.New("Bad request"),
		Code: http.StatusBadRequest,
	}
	ErrForbidden = &Error{
		Err:  errors.New("Forbidden"),
		Code: http.StatusForbidden,
	}
)

Functions

func Context

func Context(ctx context.Context) context.Context

func NewContext

func NewContext() context.Context

Types

type Error

type Error struct {
	Err  *errors.Error
	Code int
}

func ToError

func ToError(err error) *Error

func (Error) Error

func (e Error) Error() string

type Herodot

type Herodot interface {
	Write(ctx context.Context, w http.ResponseWriter, r *http.Request, e interface{})

	WriteCode(ctx context.Context, w http.ResponseWriter, r *http.Request, code int, e interface{})

	WriteCreated(ctx context.Context, w http.ResponseWriter, r *http.Request, location string, e interface{})

	WriteError(ctx context.Context, w http.ResponseWriter, r *http.Request, err error)

	WriteErrorCode(ctx context.Context, w http.ResponseWriter, r *http.Request, code int, err error)
}

type JSON

type JSON struct {
	Logger logrus.FieldLogger
}

func (*JSON) Write

func (h *JSON) Write(ctx context.Context, w http.ResponseWriter, r *http.Request, e interface{})

func (*JSON) WriteCode

func (h *JSON) WriteCode(ctx context.Context, w http.ResponseWriter, r *http.Request, code int, e interface{})

func (*JSON) WriteCreated

func (h *JSON) WriteCreated(ctx context.Context, w http.ResponseWriter, r *http.Request, location string, e interface{})

func (*JSON) WriteError

func (h *JSON) WriteError(ctx context.Context, w http.ResponseWriter, r *http.Request, err error)

func (*JSON) WriteErrorCode

func (h *JSON) WriteErrorCode(ctx context.Context, w http.ResponseWriter, r *http.Request, code int, err error)