tools

Documentation

Overview

Package tools implements various helpful tools for developing apps.

Index

• func DefaultAssetServer(directory string) http.Handler
• func DefaultErrorReporter() func(error)
• func DefaultProtector() func(http.Handler) http.Handler
• func DefaultRequestLogger() func(http.Handler) http.Handler
• func NewAssetServer(prefix, directory string) http.Handler
• func NewErrorReporter(out io.Writer) func(error)
• func NewProtector(maxBody string, corsOptions cors.Options) func(http.Handler) http.Handler
• func NewRequestLogger(out io.Writer) func(http.Handler) http.Handler
• func UnwrapResponseWriter(w http.ResponseWriter) http.ResponseWriter
• type ResponseWriter
  • func (w *ResponseWriter) WriteHeader(statusCode int)

Functions

func DefaultAssetServer

func DefaultAssetServer(directory string) http.Handler

DefaultAssetServer constructs an AssetServer that servers the directory on the root path.

func DefaultErrorReporter

func DefaultErrorReporter() func(error)

DefaultErrorReporter returns a reporter that writes to stderr.

func DefaultProtector

func DefaultProtector() func(http.Handler) http.Handler

DefaultProtector constructs a middleware that by default limits the request body size to 4Ks and sets a basic CORS configuration.

func DefaultRequestLogger

func DefaultRequestLogger() func(http.Handler) http.Handler

DefaultRequestLogger constructs a handler that logs incoming requests to the operating systems standard output.

func NewAssetServer

func NewAssetServer(prefix, directory string) http.Handler

NewAssetServer constructs an asset server handler that serves an asset directory on a specified path and serves the index file for not found paths which is needed to run single page applications like Ember.

func NewErrorReporter

func NewErrorReporter(out io.Writer) func(error)

NewErrorReporter returns a very basic reporter that writes errors and stack traces to the specified writer.

func NewProtector

func NewProtector(maxBody string, corsOptions cors.Options) func(http.Handler) http.Handler

NewProtector constructs a middleware that implements basic protection measures for the passed endpoint. Currently the protector limits the body size to a the passed length and automatically handles CORS using the specified options.

func NewRequestLogger

func NewRequestLogger(out io.Writer) func(http.Handler) http.Handler

NewRequestLogger constructs a handler that logs incoming requests to the specified writer output.

func UnwrapResponseWriter

func UnwrapResponseWriter(w http.ResponseWriter) http.ResponseWriter

UnwrapResponseWriter will try to unwrap the passed ResponseWriter.

Types

type ResponseWriter

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

ResponseWriter is the ResponseWriter that wraps the original ResponseWriter if the Logger middleware has been used in the chain.

func (*ResponseWriter) WriteHeader

func (w *ResponseWriter) WriteHeader(statusCode int)

WriteHeader calls the underlying ResponseWriters WriteHeader method.