fs

Documentation

Overview

Package fs support facilitate for handler file and direction.

Index

• Constants
• func AddEnvPath(paths ...string) string
• func Append(filename, text string) error
• func CheckDir(dir string) string
• func CheckFileDir(filename string) string
• func Copy(dstFile, srcFile string) (bool, error)
• func CopyDir(dst, src string)
• func DelEnvPath(paths ...string) string
• func EnvPath() []string
• func ExistPath(vPath string) bool
• func GetMemStatsRange() func() (runtime.MemStats, runtime.MemStats)
• func InsToFilename(filename, ins string) string
• func InsToFilenameDetect(filename, ins string) string
• func IsDir(dir string) bool
• func Put(filename, text string) error
• func RemoveList(files []string) string
• func StdDir(d string) string
• func StdPathList(paths ...string) []string
• func StdPathName(vPath string) string
• type ChildDirData
• type DirScanner
  • func NewDirScanner(vDir string) *DirScanner
  • func (ds *DirScanner) BaseDir() string
  • func (ds *DirScanner) ChanNumber() int
  • func (ds *DirScanner) Exclude(excludes ...string) *DirScanner
  • func (ds *DirScanner) Include(includes ...string) *DirScanner
  • func (ds *DirScanner) Scan() error
  • func (ds *DirScanner) ScanParallel() error
• type MemUsage
  • func (m *MemUsage) GetSysMemSub() func() number.BitSize

Constants

const (
	DirScannerChanMax = 5000
)

const (
	VEnvPath = "path"
)

Functions

func AddEnvPath

func AddEnvPath(paths ...string) string

AddEnvPath and path to env

func Append

func Append(filename, text string) error

Append append content to a file

func CheckDir

func CheckDir(dir string) string

CheckDir checkout if dir exist, when not exist will try to build it and return the path.

func CheckFileDir

func CheckFileDir(filename string) string

CheckFileDir detect whether the parent directory where the file is located exists, and use it to automatically generate the parent directory when generating files (adaptable)

func Copy

func Copy(dstFile, srcFile string) (bool, error)

Copy file by io

func CopyDir

func CopyDir(dst, src string)

CopyDir copy all file in a dir

func DelEnvPath

func DelEnvPath(paths ...string) string

DelEnvPath del the path from env path list.

func EnvPath

func EnvPath() []string

EnvPath get os env path list

func ExistPath

func ExistPath(vPath string) bool

ExistPath checkout the path of file/dir exist.

func GetMemStatsRange

func GetMemStatsRange() func() (runtime.MemStats, runtime.MemStats)

GetMemStatsRange get memory stats range callback

func InsToFilename

func InsToFilename(filename, ins string) string

InsToFilename Insert the name after the file name and before the suffix，

E.G `$s => /test/pathx/name-eg.docx` into `/test/pathx/name-eg{$s}.docx`

func InsToFilenameDetect

func InsToFilenameDetect(filename, ins string) string

InsToFilenameDetect tentatively obtaining the additional name of the inserted file

e.g.

`-custom => /test/pathx/name-eg.docx` into `/test/pathx/name-eg-custom.docx`

`custom.docx => /test/pathx/name-eg.docx` into `/test/pathx/custom.docx`

`/new/x/custom.docx => /test/pathx/name-eg.docx` into `/new/x/custom.docx`

func IsDir

func IsDir(dir string) bool

IsDir checkout string path is dir.

func Put

func Put(filename, text string) error

Put rewrite content to file

func RemoveList

func RemoveList(files []string) string

RemoveList batch remove File List

func StdDir

func StdDir(d string) string

StdDir the standard dir format

func StdPathList

func StdPathList(paths ...string) []string

StdPathList turn path list to standard path

func StdPathName

func StdPathName(vPath string) string

StdPathName the standard path format

Types

type ChildDirData

type ChildDirData struct {
	Name  string
	Size  int64
	IsDir bool
	Path  string
	Depth int // the max depth of dir. @todo need to do
}

type DirScanner

type DirScanner struct {
	AllItem      int
	AllDirItem   int
	AllFileItem  int
	AllSize      int64
	TopChildDick map[string]ChildDirData
	Runtime      time.Duration

	CddChanMax int // [Experimental]
	// contains filtered or unexported fields
}

DirScanner the tool to scan the dirs.

func NewDirScanner

func NewDirScanner(vDir string) *DirScanner

func (*DirScanner) BaseDir

func (ds *DirScanner) BaseDir() string

func (*DirScanner) ChanNumber

func (ds *DirScanner) ChanNumber() int

func (*DirScanner) Exclude

func (ds *DirScanner) Exclude(excludes ...string) *DirScanner

Exclude exclude exp for dir scan

func (*DirScanner) Include

func (ds *DirScanner) Include(includes ...string) *DirScanner

Include exclude exp for dir scan

func (*DirScanner) Scan

func (ds *DirScanner) Scan() error

Scan to star scan the dir.

func (*DirScanner) ScanParallel

func (ds *DirScanner) ScanParallel() error

ScanParallel to star scan the dir.[Experimental]

type MemUsage

type MemUsage struct {
}

MemUsage memory usage

func (*MemUsage) GetSysMemSub

func (m *MemUsage) GetSysMemSub() func() number.BitSize

GetSysMemSub get system memory range sub bytes