hackpadfs

README

hackpadfs

File system interfaces and implementations for Go.

Documentation

Index

• Constants
• Variables
• func Chmod(fs FS, name string, mode FileMode) error
• func ChmodFile(file File, mode FileMode) error
• func Chown(fs FS, name string, uid, gid int) error
• func ChownFile(file File, uid, gid int) error
• func Chtimes(fs FS, name string, atime time.Time, mtime time.Time) error
• func ChtimesFile(file File, atime, mtime time.Time) error
• func Mkdir(fs FS, name string, perm FileMode) error
• func MkdirAll(fs FS, path string, perm FileMode) error
• func ReadAtFile(file File, p []byte, off int64) (n int, err error)
• func ReadFile(fs FS, name string) ([]byte, error)
• func Remove(fs FS, name string) error
• func RemoveAll(fs FS, path string) error
• func Rename(fs FS, oldName, newName string) error
• func SeekFile(file File, offset int64, whence int) (int64, error)
• func Symlink(fs FS, oldname, newname string) error
• func SyncFile(file File) error
• func TruncateFile(file File, size int64) error
• func ValidPath(path string) bool
• func WalkDir(fs FS, root string, fn WalkDirFunc) error
• func WriteAtFile(file File, p []byte, off int64) (n int, err error)
• func WriteFile(file File, p []byte) (n int, err error)
• type ChmodFS
• type ChmoderFile
• type ChownFS
• type ChownerFile
• type ChtimesFS
• type ChtimeserFile
• type CreateFS
• type DirEntry
  • func ReadDir(fs FS, name string) ([]DirEntry, error)
  • func ReadDirFile(file File, n int) ([]DirEntry, error)
• type DirReaderFile
• type FS
  • func Sub(fs FS, dir string) (FS, error)
• type File
  • func Create(fs FS, name string) (File, error)
  • func OpenFile(fs FS, name string, flag int, perm FileMode) (File, error)
• type FileInfo
  • func Lstat(fs FS, name string) (FileInfo, error)
  • func LstatOrStat(fs FS, name string) (FileInfo, error)
  • func Stat(fs FS, name string) (FileInfo, error)
• type FileMode
• type LinkError
  • func (e *LinkError) Error() string
  • func (e *LinkError) Unwrap() error
• type LstatFS
• type MkdirAllFS
• type MkdirFS
• type MountFS
• type OpenFileFS
• type PathError
• type ReadDirFS
• type ReadFileFS
• type ReadWriterFile
• type ReaderAtFile
• type RemoveAllFS
• type RemoveFS
• type RenameFS
• type SeekerFile
• type StatFS
• type SubFS
• type SymlinkFS
• type SyncerFile
• type TruncaterFile
• type WalkDirFunc
• type WriterAtFile

Constants

const (
	FlagReadOnly  int = syscall.O_RDONLY
	FlagWriteOnly int = syscall.O_WRONLY
	FlagReadWrite int = syscall.O_RDWR

	FlagAppend    int = syscall.O_APPEND
	FlagCreate    int = syscall.O_CREAT
	FlagExclusive int = syscall.O_EXCL
	FlagSync      int = syscall.O_SYNC
	FlagTruncate  int = syscall.O_TRUNC
)

Flags are bit-wise OR'd with each other in fs.OpenFile(). Exactly one of Read/Write flags must be specified, and any other flags can be OR'd together.

const (
	ModeDir        = gofs.ModeDir
	ModeAppend     = gofs.ModeAppend
	ModeExclusive  = gofs.ModeExclusive
	ModeTemporary  = gofs.ModeTemporary
	ModeSymlink    = gofs.ModeSymlink
	ModeDevice     = gofs.ModeDevice
	ModeNamedPipe  = gofs.ModeNamedPipe
	ModeSocket     = gofs.ModeSocket
	ModeSetuid     = gofs.ModeSetuid
	ModeSetgid     = gofs.ModeSetgid
	ModeCharDevice = gofs.ModeCharDevice
	ModeSticky     = gofs.ModeSticky
	ModeIrregular  = gofs.ModeIrregular

	ModeType = gofs.ModeType
	ModePerm = gofs.ModePerm
)

Mode values are bit-wise OR'd with a file's permissions to form the FileMode. Mirror io/fs.Mode... values.

Variables

var (
	ErrInvalid    = syscall.EINVAL // TODO update to fs.ErrInvalid, once errors.Is supports it
	ErrPermission = fs.ErrPermission
	ErrExist      = fs.ErrExist
	ErrNotExist   = fs.ErrNotExist
	ErrClosed     = fs.ErrClosed

	ErrIsDir          = syscall.EISDIR
	ErrNotDir         = syscall.ENOTDIR
	ErrNotEmpty       = syscall.ENOTEMPTY
	ErrNotImplemented = syscall.ENOSYS

	SkipDir = fs.SkipDir
)

Errors commonly returned by file systems. Mirror their equivalents in the syscall and io/fs packages.

Functions

func Chmod

func Chmod(fs FS, name string, mode FileMode) error

Chmod attempts to call an optimized fs.Chmod(), falls back to opening the file and running file.Chmod().

func ChmodFile

func ChmodFile(file File, mode FileMode) error

ChmodFile runs file.Chmod() is available, fails with a not implemented error otherwise.

func Chown

func Chown(fs FS, name string, uid, gid int) error

Chown attempts to call an optimized fs.Chown(), falls back to opening the file and running file.Chown().

func ChownFile

func ChownFile(file File, uid, gid int) error

ChownFile runs file.Chown() is available, fails with a not implemented error otherwise.

func Chtimes

func Chtimes(fs FS, name string, atime time.Time, mtime time.Time) error

Chtimes attempts to call an optimized fs.Chtimes(), falls back to opening the file and running file.Chtimes().

func ChtimesFile

func ChtimesFile(file File, atime, mtime time.Time) error

ChtimesFile runs file.Chtimes() is available, fails with a not implemented error otherwise.

func Mkdir

func Mkdir(fs FS, name string, perm FileMode) error

Mkdir creates a directory. Fails with a not implemented error if it's not a MkdirFS.

func MkdirAll

func MkdirAll(fs FS, path string, perm FileMode) error

MkdirAll attempts to call an optimized fs.MkdirAll(), falls back to multiple fs.Mkdir() calls.

func ReadAtFile

func ReadAtFile(file File, p []byte, off int64) (n int, err error)

ReadAtFile runs file.ReadAt() is available, fails with a not implemented error otherwise.

func ReadFile

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

ReadFile attempts to call an optimized fs.ReadFile(), falls back to io/fs.ReadFile().

func Remove

func Remove(fs FS, name string) error

Remove removes a file with fs.Remove(). Fails with a not implemented error if it's not a RemoveFS.

func RemoveAll

func RemoveAll(fs FS, path string) error

RemoveAll removes files recursively with fs.RemoveAll(). Fails with a not implemented error if it's not a RemoveAllFS.

func Rename

func Rename(fs FS, oldName, newName string) error

Rename moves files with fs.Rename(). Fails with a not implemented error if it's not a RenameFS.

func SeekFile

func SeekFile(file File, offset int64, whence int) (int64, error)

SeekFile runs file.Seek() is available, fails with a not implemented error otherwise.

func Symlink

func Symlink(fs FS, oldname, newname string) error

Symlink creates a symlink. Fails with a not implemented error if it's not a SymlinkFS.

func SyncFile

func SyncFile(file File) error

SyncFile runs file.Sync() is available, fails with a not implemented error otherwise.

func TruncateFile

func TruncateFile(file File, size int64) error

TruncateFile runs file.Truncate() is available, fails with a not implemented error otherwise.

func ValidPath

func ValidPath(path string) bool

ValidPath returns true if 'path' is a valid FS path. See io/fs.ValidPath() for details on FS-safe paths.

func WalkDir

func WalkDir(fs FS, root string, fn WalkDirFunc) error

WalkDir recursively scans 'fs' starting at path 'root', calling 'fn' every time a new file or directory is visited.

func WriteAtFile

func WriteAtFile(file File, p []byte, off int64) (n int, err error)

WriteAtFile runs file.WriteAt() is available, fails with a not implemented error otherwise.

func WriteFile

func WriteFile(file File, p []byte) (n int, err error)

WriteFile runs file.Write() is available, fails with a not implemented error otherwise.

Types

type ChmodFS

type ChmodFS interface {
	FS
	Chmod(name string, mode FileMode) error
}

ChmodFS is an FS that can change file or directory permissions. Should match the behavior of os.Chmod().

type ChmoderFile

type ChmoderFile interface {
	File
	Chmod(mode FileMode) error
}

ChmoderFile is a File that supports Chmod() operations.

type ChownFS

type ChownFS interface {
	FS
	Chown(name string, uid, gid int) error
}

ChownFS is an FS that can change file or directory ownership. Should match the behavior of os.Chown().

type ChownerFile

type ChownerFile interface {
	File
	Chown(uid, gid int) error
}

ChownerFile is a File that supports Chown() operations.

type ChtimesFS

type ChtimesFS interface {
	FS
	Chtimes(name string, atime time.Time, mtime time.Time) error
}

ChtimesFS is an FS that can change a file's access and modified timestamps. Should match the behavior of os.Chtimes().

type ChtimeserFile

type ChtimeserFile interface {
	File
	Chtimes(atime time.Time, mtime time.Time) error
}

ChtimeserFile is a File that supports Chtimes() operations.

type CreateFS

type CreateFS interface {
	FS
	Create(name string) (File, error)
}

CreateFS is an FS that can create files. Should match the behavior of os.Create().

type DirEntry

type DirEntry = gofs.DirEntry

DirEntry is an entry read from a directory. Mirrors io/fs.DirEntry.

func ReadDir

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

ReadDir attempts to call an optimized fs.ReadDir(), falls back to io/fs.ReadDir().

func ReadDirFile

func ReadDirFile(file File, n int) ([]DirEntry, error)

ReadDirFile runs file.ReadDir() is available, fails with a not implemented error otherwise.

type DirReaderFile

type DirReaderFile interface {
	File
	ReadDir(n int) ([]DirEntry, error)
}

DirReaderFile is a File that supports ReadDir() operations. Mirrors io/fs.ReadDirFile.

type FS

type FS = gofs.FS

FS provides access to a file system and its files. It is the minimum functionality required for a file system, and mirrors Go's io/fs.FS interface.

func Sub

func Sub(fs FS, dir string) (FS, error)

Sub attempts to call an optimized fs.Sub() if available. Falls back to io/fs.Sub() otherwise.

type File

type File = gofs.File

File provides access to a file. Mirrors io/fs.File.

func Create

func Create(fs FS, name string) (File, error)

Create attempts to call an optimized fs.Create() if available, falls back to OpenFile() with create flags.

func OpenFile

func OpenFile(fs FS, name string, flag int, perm FileMode) (File, error)

OpenFile attempts to call fs.Open() or fs.OpenFile() if available. Fails with a not implemented error otherwise.

type FileInfo

type FileInfo = gofs.FileInfo

FileInfo describes a file and is returned by Stat(). Mirrors io/fs.FileInfo.

func Lstat

func Lstat(fs FS, name string) (FileInfo, error)

Lstat stats files and does not follow symlinks. Fails with a not implemented error if it's not a LstatFS.

func LstatOrStat

func LstatOrStat(fs FS, name string) (FileInfo, error)

LstatOrStat attempts to call an optimized fs.LstatOrStat(), fs.Lstat(), or fs.Stat() - whichever is supported first.

func Stat

func Stat(fs FS, name string) (FileInfo, error)

Stat attempts to call an optimized fs.Stat(), falls back to fs.Open() and file.Stat().

type FileMode

type FileMode = gofs.FileMode

FileMode represents a file's mode and permission bits. Mirrors io/fs.FileMode.

type LinkError

type LinkError struct {
	Op  string
	Old string
	New string
	Err error
}

LinkError records a file system rename error and the paths that caused it. Mirrors os.LinkError

NOTE: Is not identical to os.LinkError to avoid importing "os". Still resolves errors.Is() calls correctly.

func (*LinkError) Error

func (e *LinkError) Error() string

func (*LinkError) Unwrap

func (e *LinkError) Unwrap() error

Unwrap supports errors.Unwrap().

type LstatFS

type LstatFS interface {
	FS
	Lstat(name string) (FileInfo, error)
}

LstatFS is an FS that can lstat files. Same as Stat, but returns file info of symlinks instead of their target. Should match the behavior of os.Lstat().

type MkdirAllFS

type MkdirAllFS interface {
	FS
	MkdirAll(path string, perm FileMode) error
}

MkdirAllFS is an FS that can make all missing directories in a given path. Should match the behavior of os.MkdirAll().

type MkdirFS

type MkdirFS interface {
	FS
	Mkdir(name string, perm FileMode) error
}

MkdirFS is an FS that can make directories. Should match the behavior of os.Mkdir().

type MountFS

type MountFS interface {
	FS
	Mount(name string) (mountFS FS, subPath string)
}

MountFS is an FS that meshes one or more FS's together. Returns the FS for a file located at 'name' and its 'subPath' inside that FS.

type OpenFileFS

type OpenFileFS interface {
	FS
	OpenFile(name string, flag int, perm FileMode) (File, error)
}

OpenFileFS is an FS that can open files with the given flags and can create with the given permission. Should matche the behavior of os.OpenFile().

type PathError

type PathError = fs.PathError

PathError records a file system or file operation error and the path that caused it. Mirrors io/fs.PathError

type ReadDirFS

type ReadDirFS interface {
	FS
	ReadDir(name string) ([]DirEntry, error)
}

ReadDirFS is an FS that can read a directory and return its DirEntry's. Should match the behavior of os.ReadDir().

type ReadFileFS

type ReadFileFS interface {
	FS
	ReadFile(name string) ([]byte, error)
}

ReadFileFS is an FS that can read an entire file in one pass. Should match the behavior of os.ReadFile().

type ReadWriterFile

type ReadWriterFile interface {
	File
	io.Writer
}

ReadWriterFile is a File that supports Write() operations.

type ReaderAtFile

type ReaderAtFile interface {
	File
	io.ReaderAt
}

ReaderAtFile is a File that supports ReadAt() operations.

type RemoveAllFS

type RemoveAllFS interface {
	FS
	RemoveAll(name string) error
}

RemoveAllFS is an FS that can remove files or directories recursively. Should match the behavior of os.RemoveAll().

type RemoveFS

type RemoveFS interface {
	FS
	Remove(name string) error
}

RemoveFS is an FS that can remove files or empty directories. Should match the behavior of os.Remove().

type RenameFS

type RenameFS interface {
	FS
	Rename(oldname, newname string) error
}

RenameFS is an FS that can move files or directories. Should match the behavior of os.Rename().

type SeekerFile

type SeekerFile interface {
	File
	io.Seeker
}

SeekerFile is a File that supports Seek() operations.

type StatFS

type StatFS interface {
	FS
	Stat(name string) (FileInfo, error)
}

StatFS is an FS that can stat files or directories. Should match the behavior of os.Stat().

type SubFS

type SubFS interface {
	FS
	Sub(dir string) (FS, error)
}

SubFS is an FS that can return a subset of the current FS. The same effect as `chroot` in a program.

type SymlinkFS

type SymlinkFS interface {
	FS
	Symlink(oldname, newname string) error
}

SymlinkFS is an FS that can create symlinks. Should match the behavior of os.Symlink().

type SyncerFile

type SyncerFile interface {
	File
	Sync() error
}

SyncerFile is a File that supports Sync() operations.

type TruncaterFile

type TruncaterFile interface {
	File
	Truncate(size int64) error
}

TruncaterFile is a File that supports Truncate() operations.

type WalkDirFunc

type WalkDirFunc = gofs.WalkDirFunc

WalkDirFunc is the type of function called in WalkDir().

type WriterAtFile

type WriterAtFile interface {
	File
	io.WriterAt
}

WriterAtFile is a File that supports WriteAt() operations.