static

Documentation

Index

• func GenerateEtag(info fs.FileInfo, weak bool) string
• type FileServer
  • func NewFileServer(options *Options) *FileServer
  • func (instance *FileServer) Serve(request httpcontract.Request, logger loggingcontract.Logger) (int, nethttp.Header, []byte, bool)
  • func (instance *FileServer) ServeReader(request httpcontract.Request, logger loggingcontract.Logger) (int, nethttp.Header, io.ReadCloser, bool)
• type FileServerConfig
  • func NewFileServerConfig(mode Mode, publicDir string, indexFile string, stripPrefix string, ...) *FileServerConfig
• type Mode
• type Options
  • func NewOptions(fileServerConfig *FileServerConfig, root string, fileSystem fs.FS) *Options

Functions

func GenerateEtag

func GenerateEtag(info fs.FileInfo, weak bool) string

Types

type FileServer

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

func NewFileServer

func NewFileServer(options *Options) *FileServer

func (*FileServer) Serve

func (instance *FileServer) Serve(
	request httpcontract.Request,
	logger loggingcontract.Logger,
) (int, nethttp.Header, []byte, bool)

func (*FileServer) ServeReader

func (instance *FileServer) ServeReader(
	request httpcontract.Request,
	logger loggingcontract.Logger,
) (int, nethttp.Header, io.ReadCloser, bool)

type FileServerConfig

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

func NewFileServerConfig

func NewFileServerConfig(
	mode Mode,
	publicDir string,
	indexFile string,
	stripPrefix string,
	enableCache bool,
	cacheMaxAge int,
	weakEtag bool,
) *FileServerConfig

type Mode

type Mode string

const (
	ModeFilesystem Mode = "filesystem"
	ModeEmbedded   Mode = "embedded"
)

type Options

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

func NewOptions

func NewOptions(
	fileServerConfig *FileServerConfig,
	root string,
	fileSystem fs.FS,
) *Options