staticfs

Documentation

Overview

TODO: move this into root package.

Index

• func NewFastFileSystem(withOptions ...FastFileSystemOption) (_ http.Handler, err error)
• 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 FastFileSystemFile
  • func NewFastFileSystemFile(contents []byte) *FastFileSystemFile
  • func (f *FastFileSystemFile) HandleError(w http.ResponseWriter, r *http.Request, err error) error
  • func (f *FastFileSystemFile) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type FastFileSystemOption
  • func WithDefaultFastFileSystemFallthrough() FastFileSystemOption
  • func WithFastFileSystemFallthrough(h http.Handler) FastFileSystemOption
  • func WithFastFileSystemFile(path string, contents []byte) FastFileSystemOption
• 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

Functions

func NewFastFileSystem

func NewFastFileSystem(withOptions ...FastFileSystemOption) (_ http.Handler, err error)

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 FastFileSystemFile

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

func NewFastFileSystemFile

func NewFastFileSystemFile(contents []byte) *FastFileSystemFile

NewFastFileSystemFile serves a single file from memory without logging.

func (*FastFileSystemFile) HandleError

func (f *FastFileSystemFile) HandleError(
	w http.ResponseWriter,
	r *http.Request,
	err error,
) error

func (*FastFileSystemFile) ServeHTTP

func (f *FastFileSystemFile) ServeHTTP(
	w http.ResponseWriter,
	r *http.Request,
)

type FastFileSystemOption

type FastFileSystemOption func(*fastFileSystemOptions) error

func WithDefaultFastFileSystemFallthrough

func WithDefaultFastFileSystemFallthrough() FastFileSystemOption

func WithFastFileSystemFallthrough

func WithFastFileSystemFallthrough(h http.Handler) FastFileSystemOption

func WithFastFileSystemFile

func WithFastFileSystemFile(
	path string,
	contents []byte,
) FastFileSystemOption

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)