sashakoshka/go-gemini
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fs: Update documentation

Browse Source
This commit is contained in:
Adnan Maolood 2021-02-14 19:27:56 -05:00
parent 46e10da3a8
commit 5ec8dea1ba
1 changed files with 2 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
fs.go
View File

@ -14,10 +14,8 @@ func init() {
} }
// FileServer returns a handler that serves Gemini requests with the contents // FileServer returns a handler that serves Gemini requests with the contents
// of the file system rooted at root. // of the provided file system.
// The returned handler cleans paths before handling them. // The returned handler cleans paths before handling them.
//
// TODO: Use io/fs.FS when available.
func FileServer(fsys FS) Handler { func FileServer(fsys FS) Handler {
return fsHandler{fsys} return fsHandler{fsys}
} }
@ -41,16 +39,12 @@ func (fsh fsHandler) ServeGemini(w ResponseWriter, r *Request) {
_, _ = io.Copy(w, f) _, _ = io.Copy(w, f)
} }
// FS represents a filesystem. // FS represents a file system.
//
// TODO: Replace with io/fs.FS when available.
type FS interface { type FS interface {
Open(name string) (File, error) Open(name string) (File, error)
} }
// File represents a file. // File represents a file.
//
// TODO: Replace with io/fs.File when available.
type File interface { type File interface {
Stat() (os.FileInfo, error) Stat() (os.FileInfo, error)
Read([]byte) (int, error) Read([]byte) (int, error)
@ -58,8 +52,6 @@ type File interface {
} }
// Dir implements FS using the native filesystem restricted to a specific directory. // Dir implements FS using the native filesystem restricted to a specific directory.
//
// TODO: replace with os.DirFS when available.
type Dir string type Dir string
// Open tries to open the file with the given name. // Open tries to open the file with the given name.
@ -71,8 +63,6 @@ func (d Dir) Open(name string) (File, error) {
// ServeFile responds to the request with the contents of the named file // ServeFile responds to the request with the contents of the named file
// or directory. // or directory.
//
// TODO: Use io/fs.FS when available.
func ServeFile(w ResponseWriter, fs FS, name string) { func ServeFile(w ResponseWriter, fs FS, name string) {
f, err := fs.Open(name) f, err := fs.Open(name)
if err != nil { if err != nil {