fs

Documentation

Index

• func CreateFile(newpath string) (*os.File, error)
• func IsSpecialFSFromFileInfo(st fs.FileInfo) (bool, error)
• func MoveFileWithReplacement(src, dst string) error
• func RenameFile(oldpath, newpath string) error
• func RenameFileWithReplacement(oldpath, newpath string) error
• func SyncDir(dirName string) error
• type DiskStatus
  • func DiskUsage(path string) (*DiskStatus, error)
• type FileExistsError
  • func (e FileExistsError) Error() string

Functions

func CreateFile

func CreateFile(newpath string) (*os.File, error)

CreateFile creates a new file at newpath, returning an error if newpath already exists

func IsSpecialFSFromFileInfo

func IsSpecialFSFromFileInfo(st fs.FileInfo) (bool, error)

IsSpecialFSFromFileInfo determines if a file resides on a special file system (e.g. /proc, /dev/, /sys) based on its fs.FileInfo. The bool return value should be ignored if err is not nil.

func MoveFileWithReplacement

func MoveFileWithReplacement(src, dst string) error

MoveFileWithReplacement copies the file contents at `src` to `dst`. and deletes `src` on success.

If the file at `dst` already exists, it will be truncated and its contents overwritten.

func RenameFile

func RenameFile(oldpath, newpath string) error

RenameFile renames oldpath to newpath, returning an error if newpath already exists. If this function returns successfully, the contents of newpath will be identical to oldpath, and oldpath will be removed.

func RenameFileWithReplacement

func RenameFileWithReplacement(oldpath, newpath string) error

RenameFileWithReplacement will replace any existing file at newpath with the contents of oldpath. It works also if it the rename spans over several file systems.

If no file already exists at newpath, newpath will be created using the contents of oldpath. If this function returns successfully, the contents of newpath will be identical to oldpath, and oldpath will be removed.

func SyncDir

func SyncDir(dirName string) error

SyncDir flushes any file renames to the filesystem.

Types

type DiskStatus

type DiskStatus struct {
	All   uint64
	Used  uint64
	Free  uint64
	Avail uint64
}

DiskStatus is returned by DiskUsage

func DiskUsage

func DiskUsage(path string) (*DiskStatus, error)

DiskUsage returns disk usage of disk of path

type FileExistsError

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

A FileExistsError is returned when an operation cannot be completed due to a file already existing.

func (FileExistsError) Error

func (e FileExistsError) Error() string