server

Documentation

Index

• func AddHeadersMiddleware(next http.Handler, config *cfg.Config) http.Handler
• func NewMux(cfg *config.Config, options *Options, log *log.Logger, liveReload bool) (*http.ServeMux, errors.E)
• type FileWatcher
  • func NewFileWatcher(log *log.Logger) (*FileWatcher, errors.E)
  • func (i FileWatcher) AddRecursive(from string) errors.E
  • func (i FileWatcher) Start(callback func(string))
• type HTTPError
• type LoggingResponseWriter
  • func NewLoggingResponseWriter(w http.ResponseWriter) *LoggingResponseWriter
  • func (lrw *LoggingResponseWriter) Write(b []byte) (int, error)
  • func (lrw *LoggingResponseWriter) WriteHeader(code int)
• type Options
• type Server
  • func New(conf *config.Config, options *Options, log *log.Logger, liveReload bool) (*Server, errors.E)
  • func (s *Server) Start() errors.E
  • func (s *Server) Stop() chan struct{}

Functions

func AddHeadersMiddleware

func AddHeadersMiddleware(next http.Handler, config *cfg.Config) http.Handler

func NewMux

func NewMux(
	cfg *config.Config,
	options *Options,
	log *log.Logger,
	liveReload bool,
) (*http.ServeMux, errors.E)

Types

type FileWatcher

type FileWatcher struct {
	// contains filtered or unexported fields
}

func NewFileWatcher

func NewFileWatcher(log *log.Logger) (*FileWatcher, errors.E)

func (FileWatcher) AddRecursive

func (i FileWatcher) AddRecursive(from string) errors.E

func (FileWatcher) Start

func (i FileWatcher) Start(callback func(string))

type HTTPError

type HTTPError struct {
	Error   error
	Message string
	Code    int
}

type LoggingResponseWriter

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

func NewLoggingResponseWriter

func NewLoggingResponseWriter(w http.ResponseWriter) *LoggingResponseWriter

func (*LoggingResponseWriter) Write

func (lrw *LoggingResponseWriter) Write(b []byte) (int, error)

func (*LoggingResponseWriter) WriteHeader

func (lrw *LoggingResponseWriter) WriteHeader(code int)

type Options

type Options struct {
	ReadIndex      *index.ReadIndex
	ManpagesURLMap *manpages.URLMap
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func New

func New(
	conf *config.Config,
	options *Options,
	log *log.Logger,
	liveReload bool,
) (*Server, errors.E)

func (*Server) Start

func (s *Server) Start() errors.E

func (*Server) Stop

func (s *Server) Stop() chan struct{}