fsx

Documentation

Overview

Package fsx provides filesystem interfaces and test implementations.

Index

• func Exists(fsys FS, path string) bool
• func IsDir(fsys FS, path string) bool
• func IsFile(fsys FS, path string) bool
• type FS
• type Mem
  • func NewMem() *Mem
  • func (m *Mem) AddDir(p string) *Mem
  • func (m *Mem) AddFile(p string, content []byte) *Mem
  • func (m *Mem) Paths() []string
  • func (m *Mem) ReadDir(p string) ([]fs.DirEntry, error)
  • func (m *Mem) ReadFile(p string) ([]byte, error)
  • func (m *Mem) RemoveAll(p string) error
  • func (m *Mem) Rename(oldPath, newPath string) error
  • func (m *Mem) Stat(p string) (fs.FileInfo, error)
• type OS
  • func (OS) ReadDir(path string) ([]fs.DirEntry, error)
  • func (OS) ReadFile(path string) ([]byte, error)
  • func (OS) Stat(path string) (fs.FileInfo, error)

Functions

func Exists

func Exists(fsys FS, path string) bool

Exists reports whether path can be statted.

func IsDir

func IsDir(fsys FS, path string) bool

IsDir reports whether path exists in fsys and is a directory.

func IsFile

func IsFile(fsys FS, path string) bool

IsFile reports whether path exists in fsys and is a regular file.

Types

type FS

type FS interface {
	Stat(path string) (fs.FileInfo, error)
	ReadFile(path string) ([]byte, error)
	ReadDir(path string) ([]fs.DirEntry, error)
}

FS is the read-only filesystem surface used by pawn-project.

type Mem

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

Mem is a concurrent, in-memory FS. Paths use forward slashes.

func NewMem

func NewMem() *Mem

NewMem returns an empty in-memory filesystem containing only the root directory "/".

func (*Mem) AddDir

func (m *Mem) AddDir(p string) *Mem

AddDir creates path and any missing parent directories as directories.

func (*Mem) AddFile

func (m *Mem) AddFile(p string, content []byte) *Mem

AddFile creates path and any missing parent directories, then sets path's content.

func (*Mem) Paths

func (m *Mem) Paths() []string

Paths returns all stored paths in sorted order.

func (*Mem) ReadDir

func (m *Mem) ReadDir(p string) ([]fs.DirEntry, error)

func (*Mem) ReadFile

func (m *Mem) ReadFile(p string) ([]byte, error)

func (*Mem) RemoveAll

func (m *Mem) RemoveAll(p string) error

RemoveAll removes a path and everything below it.

func (*Mem) Rename

func (m *Mem) Rename(oldPath, newPath string) error

Rename moves a path and everything below it.

func (*Mem) Stat

func (m *Mem) Stat(p string) (fs.FileInfo, error)

type OS

type OS struct{}

OS implements FS against the real filesystem. The zero value is ready to use.

func (OS) ReadDir

func (OS) ReadDir(path string) ([]fs.DirEntry, error)

func (OS) ReadFile

func (OS) ReadFile(path string) ([]byte, error)

func (OS) Stat

func (OS) Stat(path string) (fs.FileInfo, error)