safefs

package module

Go to main page

Versions in this module

v0

v0.9.1

Nov 13, 2026

v0.9.0

Nov 8, 2026

Changes in this version

+ func IsDiskFull(err error) bool

v0.8.0

Nov 7, 2026

Changes in this version

+ const CopyMarker

+ var ErrMountInside = errors.New("a mount point lies inside the folder")

+ var ErrOutsideRoot = errors.New("path is outside the root")

+ func CopyFileNoSync(src, dst string, opts CopyOptions) error

+ func CopyInterrupted(dst string) bool

+ func Flush(dir string, files, dirs []string) error

+ func WithinRoot[T any](root, path string, fn func(dir *os.Root, name string) (T, error)) (T, error)

v0.7.1

Nov 6, 2026

v0.7.0

Nov 6, 2026

Changes in this version

+ var ErrInUse = errors.New("in use by another program")

+ type Holder struct

+ Name string

+ PID int

+ func Holders([]string) ([]Holder, error)

+ func Holders(paths []string) ([]Holder, error)

v0.6.0

Nov 2, 2026

v0.5.1

Nov 2, 2026

v0.5.0

Nov 2, 2026

Changes in this version

+ func ReadDirIfExists(path string) ([]os.DirEntry, bool, error)

v0.4.0

Nov 2, 2026

Changes in this version

+ func ReadFileIfExists(path string) ([]byte, bool, error)

+ func WalkRegular(root string, fn func(path string, d fs.DirEntry) error) error

v0.3.0

Nov 2, 2026

v0.2.0

Oct 30, 2026

v0.1.0

Oct 29, 2026

Changes in this version

+ var ErrNotRegular = errors.New("not a regular file")

+ var ErrTooLarge = errors.New("larger than its size cap")

+ func CapReader(r io.Reader, limit int64) io.Reader

+ func CheckWritable(dir string) error

+ func Chmod(path string, perm fs.FileMode) error

+ func Clone(src, dst string) error — linux/amd64, windows/amd64

+ func Clone(string, string) error — darwin/amd64, js/wasm

+ func CopyFile(src, dst string, opts CopyOptions) (err error)

+ func CopyTree(src, dst string, opts CopyOptions) (skipped []string, err error)

+ func CopyTreeFollowingLinks(src, dst string, opts CopyOptions) error

+ func Create(path string) (*os.File, error)

+ func CreateExcl(path string, perm fs.FileMode) (*os.File, error)

+ func Device(path string) (uint64, error) — linux/amd64, windows/amd64

+ func Device(string) (uint64, error) — darwin/amd64, js/wasm

+ func EvalSymlinks(p string) (string, error)

+ func ExtendedPath(abs string) string

+ func FoldCase(path string) string

+ func FreeBytes(path string) (int64, error) — darwin/amd64, linux/amd64, windows/amd64

+ func HashFile(path string, h hash.Hash) (string, error)

+ func IsDir(path string) bool

+ func IsFile(path string) bool

+ func LinkDir(link, target string) error

+ func LinkUnsupported(err error) bool

+ func LinkedDir(p string, info os.FileInfo) bool

+ func Open(path string) (*os.File, error)

+ func OpenFile(path string, flag int, perm fs.FileMode) (*os.File, error)

+ func OpenRegular(path string) (*os.File, error)

+ func ReadCapped(r io.Reader, limit int64) ([]byte, error)

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

+ func RealDirUnder(root, p string) bool

+ func Remove(path string) error

+ func RemoveAll(path string) error

+ func Rename(from, to string) error

+ func ResolveFold(fsys fs.FS, rel string) (string, error)

+ func SamePath(a, b string) bool

+ func Shared(path string) bool

+ func Size(dir string) (int64, error)

+ func SizeEachName(dir string) (int64, error)

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

+ func SyncDir(dir string) error — darwin/amd64, js/wasm, linux/amd64

+ func SyncDir(string) error — windows/amd64

+ func Trash(path string) error — js/wasm, linux/amd64, windows/amd64

+ func Trash(string) error — darwin/amd64

+ func UnderRoot(root, p string) bool

+ func Unshare(path string) error

+ func WalkFiles(root string, fn func(rel, path string, size int64) error) error

+ func Within[T any](path string, fn func(dir *os.Root, name string) (T, error)) (T, error)

+ func WriteFile(path string, data []byte, perm fs.FileMode) error

+ func WriteFileAtomic(path string, data []byte, perm os.FileMode) error

+ func WriteStreamAtomic(path string, perm os.FileMode, write func(io.Writer) error) error

+ func WriteStreamNoSync(path string, perm os.FileMode, write func(io.Writer) error) error

+ type CopyOptions struct

+ First string

+ Progress func(CopyProgress)

+ Put func(from, to, rel string) error

+ Skip func(name string) bool

+ TempSuffix string

+ type CopyProgress struct

+ Bytes int64

+ Files int

+ TotalBytes int64

+ TotalFiles int

+ type DanglingLinkError struct

+ Err error

+ Rel string

+ func (e *DanglingLinkError) Error() string

+ func (e *DanglingLinkError) Unwrap() error

+ type FileID [3]uint64

+ func HardLinkID(_ string, info os.FileInfo) (FileID, bool)

+ func HardLinkID(path string, _ os.FileInfo) (FileID, bool)

+ func HardLinkID(string, os.FileInfo) (FileID, bool)

+ type Materializer struct

+ Copy CopyOptions

+ Shareable func(rel string) bool

+ Tiers []Tier

+ func (m Materializer) File(src, dst, rel string) error

+ func (m Materializer) Tree(src, dst string) error

+ type Tier int

+ const TierClone

+ const TierCopy

+ const TierHardlink

+ const TierSymlink

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL