file

Documentation

Overview

Package file provides file I/O functionality

Index

• func AppendFile(ctx context.Context, target string, r io.Reader, perm fs.FileMode) (n int64, err error)
• func CopyDir(ctx context.Context, src, dst string) (err error)
• func CopyFile(ctx context.Context, src, dst string) (n int64, err error)
• func CopyFileWithPerm(ctx context.Context, src, dst string, perm fs.FileMode) (n int64, err error)
• func CreateTemp(baseDir string) (f *os.File, err error)
• func DeleteDir(ctx context.Context, path string) (err error)
• func Exists(path string) (e bool)
• func ExistsWithDetail(path string) (e bool, fi fs.FileInfo, err error)
• func Join(paths ...string) (path string)
• func ListInDir(path string) ([]string, error)
• func MkdirAll(path string, perm fs.FileMode) (err error)
• func MkdirTemp(baseDir string) (path string, err error)
• func MoveDir(ctx context.Context, src, dst string) (err error)
• func Open(path string, flg int, perm fs.FileMode) (file *os.File, err error)
• func OverWriteFile(ctx context.Context, target string, r io.Reader, perm fs.FileMode) (n int64, err error)
• func ReadDir(path string) (dirs []fs.DirEntry, err error)
• func ReadFile(path string) (n []byte, err error)
• func WriteFile(ctx context.Context, target string, r io.Reader, perm fs.FileMode) (n int64, err error)

Functions

func AppendFile

func AppendFile(
	ctx context.Context, target string, r io.Reader, perm fs.FileMode,
) (n int64, err error)

func CopyDir

func CopyDir(ctx context.Context, src, dst string) (err error)

func CopyFile

func CopyFile(ctx context.Context, src, dst string) (n int64, err error)

func CopyFileWithPerm

func CopyFileWithPerm(ctx context.Context, src, dst string, perm fs.FileMode) (n int64, err error)

func CreateTemp

func CreateTemp(baseDir string) (f *os.File, err error)

CreateTemp create temporary file from given base path if base path is nil temporary directory will create from Go's standard library.

func DeleteDir

func DeleteDir(ctx context.Context, path string) (err error)

DeleteDir recursively deletes each file or directory based on the path specified as an argument.

func Exists

func Exists(path string) (e bool)

Exists returns file existence.

func ExistsWithDetail

func ExistsWithDetail(path string) (e bool, fi fs.FileInfo, err error)

ExistsWithDetail returns file existence with detailed information.

func Join

func Join(paths ...string) (path string)

func ListInDir

func ListInDir(path string) ([]string, error)

ListInDir returns file list in directory.

func MkdirAll

func MkdirAll(path string, perm fs.FileMode) (err error)

MkdirAll creates directory like mkdir -p.

func MkdirTemp

func MkdirTemp(baseDir string) (path string, err error)

MkdirTemp create temporary directory from given base path if base path is nil temporary directory will create from Go's standard library.

func MoveDir

func MoveDir(ctx context.Context, src, dst string) (err error)

func Open

func Open(path string, flg int, perm fs.FileMode) (file *os.File, err error)

Open opens the file with the given path, flag and permission. If the folder does not exists, create the folder. If the file does not exist, create the file.

func OverWriteFile

func OverWriteFile(
	ctx context.Context, target string, r io.Reader, perm fs.FileMode,
) (n int64, err error)

func ReadDir

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

func ReadFile

func ReadFile(path string) (n []byte, err error)

func WriteFile

func WriteFile(
	ctx context.Context, target string, r io.Reader, perm fs.FileMode,
) (n int64, err error)