static

Documentation

Index

• func Serve(urlPrefix string, fs ServeFileSystem) gin.HandlerFunc
• func ServeRoot(urlPrefix, root string) gin.HandlerFunc
• type HTTPFileSystem
  • func FileSystem(fs http.FileSystem) *HTTPFileSystem
  • func (instance *HTTPFileSystem) Exists(prefix string, filepath string) bool
  • func (instance *HTTPFileSystem) Open(name string) (http.File, error)
• type LocalFileSystem
  • func LocalFile(root string, indexes bool) *LocalFileSystem
  • func (l *LocalFileSystem) Exists(prefix string, filepath string) bool
• type ServeFileSystem

Functions

func Serve

func Serve(urlPrefix string, fs ServeFileSystem) gin.HandlerFunc

Serve returns a middleware handler that serves static files in the provided filesystem.

func ServeRoot

func ServeRoot(urlPrefix, root string) gin.HandlerFunc

ServeRoot returns a middleware handler that serves from a filesystem directory.

Types

type HTTPFileSystem

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

HTTPFileSystem wraps around http.FileSystem.

func FileSystem

func FileSystem(fs http.FileSystem) *HTTPFileSystem

FileSystem returns an HTTPFileSystem.

func (*HTTPFileSystem) Exists

func (instance *HTTPFileSystem) Exists(prefix string, filepath string) bool

Exists returns if a path exists or not.

func (*HTTPFileSystem) Open

func (instance *HTTPFileSystem) Open(name string) (http.File, error)

Open opens a file.

type LocalFileSystem

type LocalFileSystem struct {
	http.FileSystem
	// contains filtered or unexported fields
}

LocalFileSystem represents a local file system.

func LocalFile

func LocalFile(root string, indexes bool) *LocalFileSystem

LocalFile returns an instance of a LocalFileSystem serving from a specified directory.

func (*LocalFileSystem) Exists

func (l *LocalFileSystem) Exists(prefix string, filepath string) bool

Exists returns if a path exists.

type ServeFileSystem

type ServeFileSystem interface {
	http.FileSystem
	Exists(prefix string, path string) bool
}

ServeFileSystem represents a static filesystem that can be served.