httphelper

Documentation

Index

• Variables
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func HandlerLoggerHTTP(fn Handler) http.HandlerFunc
• func HandlerLoggerRouter(fn Handler) httprouter.Handle
• func MustAsset(name string) []byte
• func NewHandlerLogEntry(r *http.Request) *log.Entry
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func WaitForStopSignal()
• type Handler
• type HandlerError
  • func MarshalCompactJsonToWriter(writer io.Writer, data interface{}) *HandlerError
  • func NewHandlerError(err error, code int) *HandlerError
  • func NewHandlerErrorDef(err error) *HandlerError
  • func PageMinimalFavicon(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError
  • func PageRouterMethodNotAllowed(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError
  • func PageRouterNotFound(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError
  • func PageRouterStopping(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError

Variables

var (
	Stopping bool
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func HandlerLoggerHTTP

func HandlerLoggerHTTP(fn Handler) http.HandlerFunc

func HandlerLoggerRouter

func HandlerLoggerRouter(fn Handler) httprouter.Handle

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func NewHandlerLogEntry

func NewHandlerLogEntry(r *http.Request) *log.Entry

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func WaitForStopSignal

func WaitForStopSignal()

Types

type Handler

type Handler func(http.ResponseWriter, *http.Request, httprouter.Params) *HandlerError

type HandlerError

type HandlerError struct {
	Error error
	Code  int
}

func MarshalCompactJsonToWriter

func MarshalCompactJsonToWriter(writer io.Writer, data interface{}) *HandlerError

func NewHandlerError

func NewHandlerError(err error, code int) *HandlerError

func NewHandlerErrorDef

func NewHandlerErrorDef(err error) *HandlerError

func PageMinimalFavicon

func PageMinimalFavicon(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError

func PageRouterMethodNotAllowed

func PageRouterMethodNotAllowed(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError

func PageRouterNotFound

func PageRouterNotFound(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError

func PageRouterStopping

func PageRouterStopping(w http.ResponseWriter, r *http.Request, p httprouter.Params) *HandlerError