common

Documentation

Overview

Package common is used to hold things that multiple packags within the mediocre-api toolkit will need to use or reference

Index

• func HTTPError(w http.ResponseWriter, r *http.Request, err error)
• type ExpectedErr
  • func ExpectedErrf(code int, s string, args ...interface{}) ExpectedErr
  • func (e ExpectedErr) Error() string

Functions

func HTTPError

func HTTPError(w http.ResponseWriter, r *http.Request, err error)

HTTPError will attempt to cast the given error to an ExpectedErr. If it's able to it will write that error and its response code back to the http.ResponseWriter. Otherwise it will log the error and send back a 500 unknown server-side error. If err is nil it will do nothing.

Types

type ExpectedErr

type ExpectedErr struct {
	Code int
	Err  string
}

ExpectedErr is an implementation of the error interface which will be used to indicate that the error being returned is an expected one and can sent back to the client

func ExpectedErrf

func ExpectedErrf(code int, s string, args ...interface{}) ExpectedErr

ExpectedErrf returns an ExpectedErr with a formatted message

func (ExpectedErr) Error

func (e ExpectedErr) Error() string

Error implements the error interface