wwwserver

Documentation

Index

• Variables
• type File
  • func NewFile(path string, mimeType string) (*File, error)
  • func (f *File) Freeze() error
  • func (f *File) Serve(resp *ResponseWriter, req *http.Request) error
  • func (f *File) ServeStatus(resp *ResponseWriter, req *http.Request, status int) error
• type FileData
  • func (f *FileData) ServeFrozen(resp *ResponseWriter, req *http.Request) error
  • func (f *FileData) ServeStatus(resp *ResponseWriter, req *http.Request, status int) error
• type HTML
  • func Default404(tryPath string) *HTML
  • func Default503() *HTML
  • func NewHTML(path string) (*HTML, error)
  • func (h *HTML) Freeze() error
  • func (h *HTML) Serve(resp *ResponseWriter, req *http.Request) error
  • func (h *HTML) ServeStatus(resp *ResponseWriter, req *http.Request, status int) error
• type Resource
• type ResponseWriter
  • func NewResponseWriter(resp http.ResponseWriter) *ResponseWriter
  • func (r *ResponseWriter) Header() http.Header
  • func (r *ResponseWriter) Size() int64
  • func (r *ResponseWriter) Status() int
  • func (r *ResponseWriter) Write(b []byte) (int, error)
  • func (r *ResponseWriter) WriteError(msg string)
  • func (r *ResponseWriter) WriteHeader(statusCode int)
• type Tree
  • func NewTree(root string, indexNames []string, mimeTypes map[string]string, ...) (*Tree, error)
  • func (t *Tree) Freeze() error
  • func (t *Tree) Serve(resp *ResponseWriter, req *http.Request) error
  • func (t *Tree) ServeFrozen(resp *ResponseWriter, req *http.Request) error

Variables

var COMPRESS = true

var DefaultIndexNames []string = []string{"index.html"}

var DefaultMimeTypes map[string]string = map[string]string{
	".bin":   "application/octet-stream",
	".css":   "text/css",
	".gif":   "image/gif",
	".html":  "text/html",
	".js":    "application/javascript",
	".json":  "application/json",
	".png":   "image/png",
	".svg":   "image/svg+xml",
	".txt":   "text/plain",
	".wasm":  "application/wasm",
	".woff2": "font/woff2",
}

Types

type File

type File struct {
	FileData
}

func NewFile

func NewFile(path string, mimeType string) (*File, error)

path here is absolute on this filesystem

func (*File) Freeze

func (f *File) Freeze() error

func (*File) Serve

func (f *File) Serve(resp *ResponseWriter, req *http.Request) error

func (*File) ServeStatus

func (f *File) ServeStatus(resp *ResponseWriter, req *http.Request, status int) error

type FileData

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

func (*FileData) ServeFrozen

func (f *FileData) ServeFrozen(resp *ResponseWriter, req *http.Request) error

func (*FileData) ServeStatus

func (f *FileData) ServeStatus(resp *ResponseWriter, req *http.Request, status int) error

type HTML

type HTML struct {
	FileData
	// contains filtered or unexported fields
}

func Default404

func Default404(tryPath string) *HTML

page not found

func Default503

func Default503() *HTML

func NewHTML

func NewHTML(path string) (*HTML, error)

func (*HTML) Freeze

func (h *HTML) Freeze() error

func (*HTML) Serve

func (h *HTML) Serve(resp *ResponseWriter, req *http.Request) error

func (*HTML) ServeStatus

func (h *HTML) ServeStatus(resp *ResponseWriter, req *http.Request, status int) error

type Resource

type Resource interface {
	Serve(resp *ResponseWriter, req *http.Request) error
	ServeFrozen(resp *ResponseWriter, req *http.Request) error
	Freeze() error
}

type ResponseWriter

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

func NewResponseWriter

func NewResponseWriter(resp http.ResponseWriter) *ResponseWriter

func (*ResponseWriter) Header

func (r *ResponseWriter) Header() http.Header

func (*ResponseWriter) Size

func (r *ResponseWriter) Size() int64

func (*ResponseWriter) Status

func (r *ResponseWriter) Status() int

func (*ResponseWriter) Write

func (r *ResponseWriter) Write(b []byte) (int, error)

func (*ResponseWriter) WriteError

func (r *ResponseWriter) WriteError(msg string)

func (*ResponseWriter) WriteHeader

func (r *ResponseWriter) WriteHeader(statusCode int)

type Tree

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

func NewTree

func NewTree(root string, indexNames []string, mimeTypes map[string]string,
	notFoundPath string) (*Tree, error)

func (*Tree) Freeze

func (t *Tree) Freeze() error

func (*Tree) Serve

func (t *Tree) Serve(resp *ResponseWriter, req *http.Request) error

func (*Tree) ServeFrozen

func (t *Tree) ServeFrozen(resp *ResponseWriter, req *http.Request) error