filterfs

Documentation

Index

• type DirFile
  • func (d *DirFile) Close() error
  • func (d *DirFile) Read(_ []byte) (int, error)
  • func (d *DirFile) ReadDir(n int) ([]fs.DirEntry, error)
  • func (d *DirFile) Stat() (fs.FileInfo, error)
• type FS
  • func New(fsys fs.FS) *FS
  • func (f *FS) Open(name string) (fs.File, error)
  • func (f *FS) ReadDir(name string) ([]fs.DirEntry, error)

Types

type DirFile

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

A ReadDirFile wrapper for fs.File

func (*DirFile) Close

func (d *DirFile) Close() error

func (*DirFile) Read

func (d *DirFile) Read(_ []byte) (int, error)

func (*DirFile) ReadDir

func (d *DirFile) ReadDir(n int) ([]fs.DirEntry, error)

func (*DirFile) Stat

func (d *DirFile) Stat() (fs.FileInfo, error)

type FS

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

FS wraps an fs.FS and hides inaccessible files and directories by returning appropriate "not found" errors or filtering them from listings.

func New

func New(fsys fs.FS) *FS

New creates a new FS wrapper around the provided filesystem.

func (*FS) Open

func (f *FS) Open(name string) (fs.File, error)

Open opens the named file for reading and if file is a directory wraps it with a ReadFileDir instance that filters out access errors

func (*FS) ReadDir

func (f *FS) ReadDir(name string) ([]fs.DirEntry, error)

ReadDir reads and returns directory entries, filtering out inaccessible items.