fileutil

Documentation

Overview

Package fileutil implements some basic functions for file operations

Index

• func ChunkRead(f *os.File, offset int64, size int, bufPool *sync.Pool) []string
• func ClearFile(path string) error
• func CopyFile(srcFilePath string, dstFilePath string) error
• func CreateDir(absPath string) error
• func CreateFile(path string) bool
• func CurrentPath() string
• func FileMode(path string) (fs.FileMode, error)
• func FileSize(path string) (int64, error)
• func IsDir(path string) bool
• func IsExist(path string) bool
• func IsLink(path string) bool
• func IsZipFile(filepath string) bool
• func ListFileNames(path string) ([]string, error)
• func MTime(filepath string) (int64, error)
• func MiMeType(file interface{}) string
• func ParallelChunkRead(filePath string, linesCh chan<- []string, ChunkSizeMB, MaxGoroutine int)
• func ReadCsvFile(filepath string, delimiter ...rune) ([][]string, error)
• func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error)
• func ReadFileByLine(path string) ([]string, error)
• func ReadFileToString(path string) (string, error)
• func RemoveFile(path string) error
• func Sha(filepath string, shaType ...int) (string, error)
• func UnZip(zipFile string, destPath string) error
• func WriteBytesToFile(filepath string, content []byte) error
• func WriteCsvFile(filepath string, records [][]string, append bool, delimiter ...rune) error
• func WriteMapsToCsv(filepath string, records []map[string]interface{}, appendToExistingFile bool, ...) error
• func WriteStringToFile(filepath string, content string, append bool) error
• func Zip(path string, destPath string) error
• func ZipAppendEntry(fpath string, destPath string) error

Functions

func ChunkRead

func ChunkRead(f *os.File, offset int64, size int, bufPool *sync.Pool) []string

ChunkRead 从文件的指定偏移读取块并返回块内所有行

func ClearFile

func ClearFile(path string) error

ClearFile write empty string to path file

func CopyFile

func CopyFile(srcFilePath string, dstFilePath string) error

CopyFile copy src file to dest file

func CreateDir

func CreateDir(absPath string) error

CreateDir create directory in absolute path. param `absPath` like /a/, /a/b/

func CreateFile

func CreateFile(path string) bool

CreateFile create a file in path

func CurrentPath

func CurrentPath() string

CurrentPath return current absolute path.

func FileMode

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

FileMode return file's mode and permission

func FileSize

func FileSize(path string) (int64, error)

FileSize returns file size in bytes.

func IsDir

func IsDir(path string) bool

IsDir checks if the path is directory or not

func IsExist

func IsExist(path string) bool

IsExist checks if a file or directory exists

func IsLink

func IsLink(path string) bool

IsLink checks if a file is symbol link or not

func IsZipFile

func IsZipFile(filepath string) bool

IsZipFile checks if file is zip or not.

func ListFileNames

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

ListFileNames return all file names in the path

func MTime

func MTime(filepath string) (int64, error)

MTime returns file modified time.

func MiMeType

func MiMeType(file interface{}) string

MiMeType return file mime type param `file` should be string(file path) or *os.File

func ParallelChunkRead

func ParallelChunkRead(filePath string, linesCh chan<- []string, ChunkSizeMB, MaxGoroutine int)

并行读取文件并将每个块的行发送到指定通道 filePath 文件路径 ChunkSizeMB 分块的大小（单位MB，设置为0时使用默认100MB）,设置过大反而不利，视情调整 MaxGoroutine 并发读取分块的数量，设置为0时使用CPU核心数 linesCh用于接收返回结果的通道。

func ReadCsvFile

func ReadCsvFile(filepath string, delimiter ...rune) ([][]string, error)

ReadCsvFile read file content into slice.

func ReadFile

func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error)

ReadFile get file reader by a url or a local file.

func ReadFileByLine

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

ReadFileByLine read file line by line

func ReadFileToString

func ReadFileToString(path string) (string, error)

ReadFileToString return string of file content

func RemoveFile

func RemoveFile(path string) error

RemoveFile remove the path file

func Sha

func Sha(filepath string, shaType ...int) (string, error)

Sha returns file sha value, param `shaType` should be 1, 256 or 512.

func UnZip

func UnZip(zipFile string, destPath string) error

UnZip unzip the file and save it to destPath

func WriteBytesToFile

func WriteBytesToFile(filepath string, content []byte) error

WriteBytesToFile write bytes to target file.

func WriteCsvFile

func WriteCsvFile(filepath string, records [][]string, append bool, delimiter ...rune) error

WriteCsvFile write content to target csv file.

func WriteMapsToCsv

func WriteMapsToCsv(filepath string, records []map[string]interface{}, appendToExistingFile bool, delimiter rune, headers ...[]string) error

WriteMapsToCsv write slice of map to csv file. Play: https://go.dev/play/p/umAIomZFV1c filepath: Path to the CSV file. records: Slice of maps to be written. the value of map should be basic type. the maps will be sorted by key in alphabeta order, then be written into csv file. appendToExistingFile: If true, data will be appended to the file if it exists. delimiter: Delimiter to use in the CSV file. headers: order of the csv column headers, needs to be consistent with the key of the map.

func WriteStringToFile

func WriteStringToFile(filepath string, content string, append bool) error

WriteStringToFile write string to target file.

func Zip

func Zip(path string, destPath string) error

Zip create zip file, fpath could be a single file or a directory

func ZipAppendEntry

func ZipAppendEntry(fpath string, destPath string) error

ZipAppendEntry append a single file or directory by fpath to an existing zip file. Play: https://go.dev/play/p/cxvaT8TRNQp