zfile

Documentation

Overview

Package zfile file and path operations in daily development

Index

• Constants
• Variables
• func CopyDir(source string, dest string, ...) (err error)
• func CopyFile(source string, dest string) (err error)
• func DirExist(path string) bool
• func FileExist(path string) bool
• func FileSize(file string) (size string)
• func FileSizeUint(file string) (size uint64)
• func GetMimeType(filename string, content []byte) (ctype string)
• func GzCompress(currentPath, dest string) (err error)
• func GzDeCompress(tarFile, dest string) error
• func HasPermission(path string, perm os.FileMode, noUp ...bool) bool
• func HasReadWritePermission(path string) bool
• func IsSubPath(subPath, path string) bool
• func MemoryFileAutoFlush(second int64) func(*MemoryFile)
• func MemoryFileFlushBefore(fn memoryFileFlushBefore) func(*MemoryFile)
• func MoveFile(source string, dest string, force ...bool) error
• func PathExist(path string) (int, error)
• func ProgramPath(addSlash ...bool) (path string)
• func PutAppend(path string, b []byte) (err error)
• func PutOffset(path string, b []byte, offset int64) (err error)
• func ReadFile(path string) ([]byte, error)
• func ReadLineFile(path string, handle func(line int, data []byte) error) (err error)
• func RealPath(path string, addSlash ...bool) (realPath string)
• func RealPathMkdir(path string, addSlash ...bool) string
• func Remove(path string) error
• func Rmdir(path string, notIncludeSelf ...bool) (ok bool)
• func RootPath() string
• func SafePath(path string, pathRange ...string) string
• func SizeFormat(s uint64) string
• func StatDir(path string, options ...DirStatOptions) (size, total uint64, err error)
• func TmpPath(pattern ...string) string
• func WriteFile(path string, b []byte, isAppend ...bool) (err error)
• func ZipCompress(currentPath, dest string) (err error)
• func ZipDeCompress(zipFile, dest string) error
• type DirStatOptions
• type MemoryFile
  • func NewMemoryFile(name string, opt ...MemoryFileOption) *MemoryFile
  • func (f *MemoryFile) Bytes() []byte
  • func (f *MemoryFile) Close() error
  • func (f *MemoryFile) IsDir() bool
  • func (f *MemoryFile) ModTime() time.Time
  • func (f *MemoryFile) Mode() os.FileMode
  • func (f *MemoryFile) Name() string
  • func (f *MemoryFile) Read(buffer []byte) (int, error)
  • func (f *MemoryFile) Seek(offset int64, whence int) (int64, error)
  • func (f *MemoryFile) SetName(name string)
  • func (f *MemoryFile) Size() int64
  • func (f *MemoryFile) Stat() (os.FileInfo, error)
  • func (f *MemoryFile) Sync() error
  • func (f *MemoryFile) Sys() interface{}
  • func (f *MemoryFile) Write(buffer []byte) (int, error)
• type MemoryFileOption

Constants

const (
	BYTE = 1 << (iota * 10)
	KB
	MB
	GB
	TB
)

Variables

var ProjectPath = "./"

Functions

func CopyDir

func CopyDir(source string, dest string, filterFn ...func(srcFilePath, destFilePath string) bool) (err error)

CopyDir copies the source directory to the dest directory.

func CopyFile

func CopyFile(source string, dest string) (err error)

CopyFile copies the source file to the dest file.

func DirExist

func DirExist(path string) bool

DirExist Is it an existing directory

func FileExist

func FileExist(path string) bool

FileExist Is it an existing file?

func FileSize

func FileSize(file string) (size string)

FileSize file size

func FileSizeUint

func FileSizeUint(file string) (size uint64)

FileSizeUint file size to uint64

func GetMimeType

func GetMimeType(filename string, content []byte) (ctype string)

GetMimeType get file mime type

func GzCompress

func GzCompress(currentPath, dest string) (err error)

GzCompress use gzip to compress to tar.gz

func GzDeCompress

func GzDeCompress(tarFile, dest string) error

GzDeCompress unzip tar.gz

func HasPermission

func HasPermission(path string, perm os.FileMode, noUp ...bool) bool

HasPermission check file or directory permission

func HasReadWritePermission

func HasReadWritePermission(path string) bool

HasReadWritePermission check file or directory read and write permission

func IsSubPath

func IsSubPath(subPath, path string) bool

IsSubPath Is the subPath under the path

func MemoryFileAutoFlush

func MemoryFileAutoFlush(second int64) func(*MemoryFile)

func MemoryFileFlushBefore

func MemoryFileFlushBefore(fn memoryFileFlushBefore) func(*MemoryFile)

MemoryFileFlushBefore is a function that will be called before flush to disk,take care to avoid writing to prevent deadlocks

func MoveFile

func MoveFile(source string, dest string, force ...bool) error

MoveFile Move File

func PathExist

func PathExist(path string) (int, error)

PathExist PathExist 1 exists and is a directory path, 2 exists and is a file path, 0 does not exist

func ProgramPath

func ProgramPath(addSlash ...bool) (path string)

ProgramPath program directory path

func PutAppend

func PutAppend(path string, b []byte) (err error)

PutAppend open the specified file and write data at the end of the file

func PutOffset

func PutOffset(path string, b []byte, offset int64) (err error)

PutOffset open the specified file and write data from the specified location

func ReadFile

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

ReadFile ReadFile

func ReadLineFile

func ReadLineFile(path string, handle func(line int, data []byte) error) (err error)

ReadLineFile ReadLineFile

func RealPath

func RealPath(path string, addSlash ...bool) (realPath string)

RealPath get an absolute path

func RealPathMkdir

func RealPathMkdir(path string, addSlash ...bool) string

RealPathMkdir get an absolute path, create it if it doesn't exist If you want to ensure that the directory can be created successfully, please use HasReadWritePermission to check the permission first

func Remove

func Remove(path string) error

Remove removes the named file or (empty) directory

func Rmdir

func Rmdir(path string, notIncludeSelf ...bool) (ok bool)

Rmdir support to keep the current directory

func RootPath

func RootPath() string

RootPath Project Launch Path

func SafePath

func SafePath(path string, pathRange ...string) string

SafePath get an safe absolute path

func SizeFormat

func SizeFormat(s uint64) string

SizeFormat Format file size

func StatDir

func StatDir(path string, options ...DirStatOptions) (size, total uint64, err error)

StatDir get directory size and total files

func TmpPath

func TmpPath(pattern ...string) string

func WriteFile

func WriteFile(path string, b []byte, isAppend ...bool) (err error)

WriteFile WriteFile

func ZipCompress

func ZipCompress(currentPath, dest string) (err error)

ZipCompress zip

func ZipDeCompress

func ZipDeCompress(zipFile, dest string) error

Types

type DirStatOptions

type DirStatOptions struct {
	MaxSize  uint64 // max size
	MaxTotal uint64 // max total files
}

type MemoryFile

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

func NewMemoryFile

func NewMemoryFile(name string, opt ...MemoryFileOption) *MemoryFile

func (*MemoryFile) Bytes

func (f *MemoryFile) Bytes() []byte

func (*MemoryFile) Close

func (f *MemoryFile) Close() error

func (*MemoryFile) IsDir

func (f *MemoryFile) IsDir() bool

func (*MemoryFile) ModTime

func (f *MemoryFile) ModTime() time.Time

func (*MemoryFile) Mode

func (f *MemoryFile) Mode() os.FileMode

func (*MemoryFile) Name

func (f *MemoryFile) Name() string

func (*MemoryFile) Read

func (f *MemoryFile) Read(buffer []byte) (int, error)

func (*MemoryFile) Seek

func (f *MemoryFile) Seek(offset int64, whence int) (int64, error)

func (*MemoryFile) SetName

func (f *MemoryFile) SetName(name string)

func (*MemoryFile) Size

func (f *MemoryFile) Size() int64

func (*MemoryFile) Stat

func (f *MemoryFile) Stat() (os.FileInfo, error)

func (*MemoryFile) Sync

func (f *MemoryFile) Sync() error

func (*MemoryFile) Sys

func (f *MemoryFile) Sys() interface{}

func (*MemoryFile) Write

func (f *MemoryFile) Write(buffer []byte) (int, error)

type MemoryFileOption

type MemoryFileOption func(*MemoryFile)