staticfs

Documentation

Overview

Package staticfs adapts http.FS to [oakmux.Handler] signature.

Index

• Variables
• type FS
  • func New(withOptions ...Option) (_ *FS, err error)
  • func (fs *FS) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (fs *FS) ServeHyperText(w http.ResponseWriter, r *http.Request) (err error)
  • func (fs *FS) String() string
• type NotFoundError
  • func (e *NotFoundError) Error() string
  • func (e *NotFoundError) HyperTextStatusCode() int
• type Option
  • func WithDirectory(p string) Option
  • func WithFileSystem(fs fs.FS) Option
  • func WithPath(external, real string) Option
  • func WithPathTranslators(ts ...PathTranslator) Option
• type PathTranslator

Variables

var ErrNotFound = &NotFoundError{}

Types

type FS

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

func New

func New(withOptions ...Option) (_ *FS, err error)

func (*FS) ServeHTTP

func (fs *FS) ServeHTTP(
	w http.ResponseWriter,
	r *http.Request,
)

func (*FS) ServeHyperText

func (fs *FS) ServeHyperText(
	w http.ResponseWriter,
	r *http.Request,
) (err error)

func (*FS) String

func (fs *FS) String() string

type NotFoundError

type NotFoundError struct{}

func (*NotFoundError) Error

func (e *NotFoundError) Error() string

func (*NotFoundError) HyperTextStatusCode

func (e *NotFoundError) HyperTextStatusCode() int

type Option

type Option func(*options) error

func WithDirectory

func WithDirectory(p string) Option

func WithFileSystem

func WithFileSystem(fs fs.FS) Option

func WithPath

func WithPath(external, real string) Option

func WithPathTranslators

func WithPathTranslators(ts ...PathTranslator) Option

type PathTranslator

type PathTranslator func(real string) (external string, accept bool, err error)