fs

Documentation

Index

• type Dir
  • func NewDir(name string, files []fs.File) *Dir
  • func (d *Dir) Close() error
  • func (d *Dir) Read([]byte) (int, error)
  • func (d *Dir) ReadDir(n int) ([]fs.DirEntry, error)
  • func (d *Dir) Stat() (fs.FileInfo, error)
• type DirEntry
  • func (de *DirEntry) Info() (fs.FileInfo, error)
  • func (de *DirEntry) IsDir() bool
  • func (de *DirEntry) Name() string
  • func (de *DirEntry) Open() (fs.File, error)
  • func (de *DirEntry) Type() fs.FileMode
• type DirInfo
  • func (di *DirInfo) IsDir() bool
  • func (di *DirInfo) ModTime() time.Time
  • func (di *DirInfo) Mode() fs.FileMode
  • func (di *DirInfo) Name() string
  • func (di *DirInfo) Size() int64
  • func (di *DirInfo) Sys() interface{}
• type Opener
• type OsFs
  • func (fs *OsFs) Open(name string) (fs.File, error)
  • func (fs *OsFs) ReadDir(name string) ([]fs.DirEntry, error)
  • func (fs *OsFs) ReadFile(name string) ([]byte, error)
  • func (fs *OsFs) Stat(name string) (fs.FileInfo, error)

Types

type Dir

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

func NewDir

func NewDir(name string, files []fs.File) *Dir

NewDir creates a new fs.File compatible "directory" from the passed slice of fs.File.

It implements fs.ReadDir and directory entries returned implement Opener, allowing access to the underlying files passed here.

You can add nested directories (of the same type) to this directory. Adding filesystem directories to this directory is NOT supported.

func (*Dir) Close

func (d *Dir) Close() error

func (*Dir) Read

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

func (*Dir) ReadDir

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

ReadDir reads the contents of the directory and returns a slice of up to n DirEntry values in directory order.

func (*Dir) Stat

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

type DirEntry

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

func (*DirEntry) Info

func (de *DirEntry) Info() (fs.FileInfo, error)

func (*DirEntry) IsDir

func (de *DirEntry) IsDir() bool

func (*DirEntry) Name

func (de *DirEntry) Name() string

func (*DirEntry) Open

func (de *DirEntry) Open() (fs.File, error)

func (*DirEntry) Type

func (de *DirEntry) Type() fs.FileMode

type DirInfo

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

func (*DirInfo) IsDir

func (di *DirInfo) IsDir() bool

func (*DirInfo) ModTime

func (di *DirInfo) ModTime() time.Time

func (*DirInfo) Mode

func (di *DirInfo) Mode() fs.FileMode

func (*DirInfo) Name

func (di *DirInfo) Name() string

func (*DirInfo) Size

func (di *DirInfo) Size() int64

func (*DirInfo) Sys

func (di *DirInfo) Sys() interface{}

type Opener

type Opener interface {
	Open() (fs.File, error)
}

type OsFs

type OsFs struct{}

OsFs is an implementation of fs.FS backed by os.

func (*OsFs) Open

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

func (*OsFs) ReadDir

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

func (*OsFs) ReadFile

func (fs *OsFs) ReadFile(name string) ([]byte, error)

func (*OsFs) Stat

func (fs *OsFs) Stat(name string) (fs.FileInfo, error)