fs

Documentation

Index

• Constants
• Variables
• func All(path string) (iter.Seq[os.DirEntry], *multierr.MultiError)
• func Copy(src, dst string) error
• func CopyByMode(src, dst string, c mode) error
• func CopyDir(src, dst string) error
• func CopyDirByMode(src, dst string, c mode) error
• func Create(filepath string) (*os.File, error)
• func CreateFromReader(filepath string, reader io.Reader) error
• func CreateFromReaderByMode(filepath string, reader io.Reader, c mode) error
• func CreateTime(path string) time.Time
• func CreateTimeByEntry(entry os.DirEntry) time.Time
• func CreateTimeByInfo(fileInfo os.FileInfo) time.Time
• func DirsDeDuplicate(dirs ...string) error
• func DirsDuplicateHandle(callback func(path1, path2 string) error, dirs ...string) error
• func DirsRangeDuplicateHandle(rangeCallback func(dir string, entry os.DirEntry) (error, bool), ...) error
• func Download(filepath string, reader io.Reader) error
• func DownloadByMode(filepath string, reader io.Reader, c mode) error
• func Exist(filepath string) bool
• func Find(path string) (string, error)
• func FindFiles(path string, deep int8, num int) ([]string, error)
• func FindFiles2(path string, deep int8, num int) ([]string, error)
• func GetMd5Name(name string) string
• func Inspect(dir string, file func(string, os.DirEntry) bool) error
• func IsExist(src string) bool
• func IsNotExist(src string) bool
• func IsPermission(src string) bool
• func LastFile(dir string) (os.FileInfo, map[string]os.FileInfo, error)
• func Md5(path string) (string, error)
• func Md5Equal(path1, path2 string) (bool, error)
• func Mkdir(src string) error
• func MkdirAll(src string) error
• func Move(src, dst string) error
• func MoveDirByMode(src, dst string, c mode) error
• func MustOpen(filePath string) (*os.File, error)
• func NotExist(filepath string) bool
• func Open(filepath string) (*os.File, error)
• func OpenFile(path string, flag int, perm os.FileMode) (*os.File, error)
• func Range(dir string, callback RangeCallback) error
• func RangeDeep(dir string, callback RangeCallback, deep int) error
• func RangeDir(dir string, ...) error
• func RangeFile(dir string, callback RangeCallback) error
• func RangeFileDeep(dir string, callback RangeCallback, deep int) error
• func RangeFileUntil(dir string, callback RangeUntilCallback) error
• func Sync(mainDir, slaveDir string) error
• func TwoDirDeDuplicate(dir1, dir2 string) error
• func TwoDirDuplicateHandle(dir1, dir2 string, callback func(path1, path2 string) error) error
• func Walk(root string, fn filepath.WalkFunc) error
• func WalkDir(root string, fn fs.WalkDirFunc) error
• func WalkDirFS(fsys fs.FS, root string, fn fs.WalkDirFunc) error
• func Write(data []byte, filename string) (n int, err error)
• func WriteBuffer(buf *bytes.Buffer, filename string) (n int, err error)
• type Dir
  • func (d Dir) Open(name string) (*os.File, error)
• type FileSize
  • func (f FileSize) MarshalText() ([]byte, error)
  • func (f *FileSize) UnmarshalText(text []byte) error
• type FileType
• type RangeCallback
• type RangeUntilCallback
• type Visitor

Constants

const (
	Cover mode = iota
	SameNameSkip
	SameNameAndMd5Skip
)

const DownloadKey = ".downloading"

const PathSeparator = string(os.PathSeparator)

Variables

var FileTypeMap = map[string]FileType{
	".txt": Txt,
	".doc": Doc,
}

Functions

func All

func All(path string) (iter.Seq[os.DirEntry], *multierr.MultiError)

func Copy

func Copy(src, dst string) error

Copy : General Approach

func CopyByMode

func CopyByMode(src, dst string, c mode) error

func CopyDir

func CopyDir(src, dst string) error

CopyDir 递归复制目录

func CopyDirByMode

func CopyDirByMode(src, dst string, c mode) error

CopyDirByMode 递归复制目录

func Create

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

func CreateFromReader

func CreateFromReader(filepath string, reader io.Reader) error

func CreateFromReaderByMode

func CreateFromReaderByMode(filepath string, reader io.Reader, c mode) error

func CreateTime

func CreateTime(path string) time.Time

func CreateTimeByEntry

func CreateTimeByEntry(entry os.DirEntry) time.Time

func CreateTimeByInfo

func CreateTimeByInfo(fileInfo os.FileInfo) time.Time

func DirsDeDuplicate

func DirsDeDuplicate(dirs ...string) error

去除目录中重复的文件,默认保留参数靠前目录中的文件

func DirsDuplicateHandle

func DirsDuplicateHandle(callback func(path1, path2 string) error, dirs ...string) error

func DirsRangeDuplicateHandle

func DirsRangeDuplicateHandle(rangeCallback func(dir string, entry os.DirEntry) (error, bool), duplicateCallback func(path1, path2 string) error, dirs ...string) error

DirsRangeDuplicateHandle rangeCallback 返回值为错误和是否继续

func Download

func Download(filepath string, reader io.Reader) error

func DownloadByMode

func DownloadByMode(filepath string, reader io.Reader, c mode) error

func Exist

func Exist(filepath string) bool

func Find

func Find(path string) (string, error)

path和filepath两个包，filepath文件专用

func FindFiles

func FindFiles(path string, deep int8, num int) ([]string, error)

func FindFiles2

func FindFiles2(path string, deep int8, num int) ([]string, error)

path和filepath两个包，filepath文件专用

func GetMd5Name

func GetMd5Name(name string) string

func Inspect

func Inspect(dir string, file func(string, os.DirEntry) bool) error

Inspect

func IsExist

func IsExist(src string) bool

func IsNotExist

func IsNotExist(src string) bool

func IsPermission

func IsPermission(src string) bool

func LastFile

func LastFile(dir string) (os.FileInfo, map[string]os.FileInfo, error)

LastFile 当前目录最后一个创建的文件

func Md5

func Md5(path string) (string, error)

func Md5Equal

func Md5Equal(path1, path2 string) (bool, error)

func Mkdir

func Mkdir(src string) error

func MkdirAll

func MkdirAll(src string) error

func Move

func Move(src, dst string) error

func MoveDirByMode

func MoveDirByMode(src, dst string, c mode) error

func MustOpen

func MustOpen(filePath string) (*os.File, error)

func NotExist

func NotExist(filepath string) bool

func Open

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

func OpenFile

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

func Range

func Range(dir string, callback RangeCallback) error

遍历根目录中的每个文件，为每个文件调用callback,包括文件夹,与filepath.WalkDir不同的是回调函数的参数不同,filepath.WalkDir的第一个参数是文件完整路径,RangeFile是文件所在目录的路径

func RangeDeep

func RangeDeep(dir string, callback RangeCallback, deep int) error

指定遍历深度,0为只遍历一层,-1为无限遍历

func RangeDir

func RangeDir(dir string, callback func(dir string, entries []os.DirEntry) ([]os.DirEntry, error)) error

RangeDir 遍历根目录中的每个文件夹，为文件夹中所有文件和目录的切片(os.ReadDir的返回)调用callback callback 需要处理每个文件夹下的所有文件和目录,返回值为需要递归遍历的目录和error 几乎每个文件夹下的文件夹都会被循环两次！

func RangeFile

func RangeFile(dir string, callback RangeCallback) error

遍历根目录中的每个文件，为每个文件调用callback,不包括文件夹,与filepath.WalkDir不同的是回调函数的参数不同,filepath.WalkDir的第一个参数是文件完整路径,RangeFile是文件所在目录的路径

func RangeFileDeep

func RangeFileDeep(dir string, callback RangeCallback, deep int) error

指定遍历深度,0为只遍历一层,-1为无限遍历

func RangeFileUntil

func RangeFileUntil(dir string, callback RangeUntilCallback) error

func Sync

func Sync(mainDir, slaveDir string) error

两个目录同步,第一个参数为主目录,参考目录,第二个参数目录与第一个保持一致

func TwoDirDeDuplicate

func TwoDirDeDuplicate(dir1, dir2 string) error

去除两个目录中重复的文件,默认保留第一个目录中的文件

func TwoDirDuplicateHandle

func TwoDirDuplicateHandle(dir1, dir2 string, callback func(path1, path2 string) error) error

func Walk

func Walk(root string, fn filepath.WalkFunc) error

func WalkDir

func WalkDir(root string, fn fs.WalkDirFunc) error

func WalkDirFS

func WalkDirFS(fsys fs.FS, root string, fn fs.WalkDirFunc) error

func Write

func Write(data []byte, filename string) (n int, err error)

func WriteBuffer

func WriteBuffer(buf *bytes.Buffer, filename string) (n int, err error)

Types

type Dir

type Dir string

func (Dir) Open

func (d Dir) Open(name string) (*os.File, error)

type FileSize

type FileSize int64

func (FileSize) MarshalText

func (f FileSize) MarshalText() ([]byte, error)

MarshalText

func (*FileSize) UnmarshalText

func (f *FileSize) UnmarshalText(text []byte) error

UnMarshalText

type FileType

type FileType int

const (
	Unknown FileType = iota
	Txt
	Doc
	Docx
	Xls
	Xlsx
)

type RangeCallback

type RangeCallback = func(dir string, entry os.DirEntry) error

type RangeUntilCallback

type RangeUntilCallback = func(dir string, entry os.DirEntry) (stop bool, err error)

type Visitor

type Visitor interface {
	Visit(dir string, file os.DirEntry) (w Visitor)
}