fsutil

Documentation

Index

• Constants
• Variables
• func Copy(src, dst string) error
• func CopyAll(src, dst string) error
• func Create(v string) (*os.File, error)
• func CreateTemp(dir string, pattern string) (*os.File, error)
• func IsDir(path string) bool
• func IsExist(path string) bool
• func IsFile(path string) bool
• func Mkdir(path string, mode ...fs.FileMode) error
• func Move(src, dst string) error
• func NewWriter(path string) (*nn, error)
• func Open(v string) (*os.File, error)
• func OpenFile(name string, flag int, perm fs.FileMode) (*os.File, error)
• func OpenRead(v string) ([]byte, error)
• func ReadAll(r io.Reader) ([]byte, error)
• func ReadDir(path string) (f []string)
• func ReadDirAll(path string) (f []string)
• func ReadDirInfo(path string) (r []fs.FileInfo)
• func ReadDirRaw(path string) ([]fs.DirEntry, error)
• func Remove(v string) error
• func Rename(old, new string) error
• func Stat(w string) (os.FileInfo, error)
• func TruncWrite(path string, d any) error
• func Write(path string, d any) error

Constants

const (
	O_ModePerm fs.FileMode = 511

	// O_TRUNC = os.O_WRONLY|os.O_TRUNC|os.O_CREATE
	O_TRUNC int = 577

	// O_RDWTRUNC = os.O_RDWR|os.O_CREATE|os.O_TRUNC
	O_RDWTRUNC int = 578

	// O_RDONLY = os.O_RDONLY
	O_RDONLY int = 0

	// O_WROC = os.O_WRONLY|os.O_CREATE
	O_WROC int = 65
)

Variables

var (
	ErrNotExist error = errors.New("ulib.fsutil: no file/folder found")
	ErrMethods  error = errors.New("ulib.fsutil: don't use weird methods")
)

Functions

func Copy

func Copy(src, dst string) error

func CopyAll

func CopyAll(src, dst string) error

func Create

func Create(v string) (*os.File, error)

func CreateTemp

func CreateTemp(dir string, pattern string) (*os.File, error)

CreateTemp creates a new temporary file in the directory dir, opens the file for reading and writing, and returns the resulting file.

The filename is generated by taking pattern and adding a random string to the end.

If pattern includes a "*", the random string replaces the last "*".

If dir is the empty string, CreateTemp uses the default directory for temporary files, as returned by TempDir.

Multiple programs or goroutines calling CreateTemp simultaneously will not choose the same file.

The caller can use the file's Name method to find the pathname of the file.

It is the caller's responsibility to remove the file when it is no longer needed.

func IsDir

func IsDir(path string) bool

This function will check if the target is a directory.

**When the target does not exist or other errors occur, it will return `false`**

func IsExist

func IsExist(path string) bool

This function checks if the target exists.

func IsFile

func IsFile(path string) bool

func Mkdir

func Mkdir(path string, mode ...fs.FileMode) error

func Move

func Move(src, dst string) error

func NewWriter

func NewWriter(path string) (*nn, error)

Higher performance sustainable file write operations.

Example Files: `writer_test.go`

func Open

func Open(v string) (*os.File, error)

Open opens the named file for reading.

If successful, methods on the returned file can be used for reading; the associated file descriptor has mode O_RDONLY.

If there is an error, it will be of type *PathError.

func OpenFile

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

OpenFile is the generalized open call; most users will use Open or Create instead. It opens the named file with specified flag (O_RDONLY etc.). If the file does not exist, and the O_CREATE flag is passed, it is created with mode perm (before umask). If successful, methods on the returned File can be used for I/O. If there is an error, it will be of type *PathError.

func OpenRead

func OpenRead(v string) ([]byte, error)

func ReadAll

func ReadAll(r io.Reader) ([]byte, error)

ReadAll reads from r until an error or EOF and returns the data it read. A successful call returns err == nil, not err == EOF. Because ReadAll is defined to read from src until EOF, it does not treat an EOF from Read as an error to be reported.

func ReadDir

func ReadDir(path string) (f []string)

func ReadDirAll

func ReadDirAll(path string) (f []string)

func ReadDirInfo

func ReadDirInfo(path string) (r []fs.FileInfo)

func ReadDirRaw

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

func Remove

func Remove(v string) error

func Rename

func Rename(old, new string) error

func Stat

func Stat(w string) (os.FileInfo, error)

func TruncWrite

func TruncWrite(path string, d any) error

func Write

func Write(path string, d any) error