fs

Documentation

Overview

Package fs support facilitate for handler file and direction.

Index

• Constants
• func AddEnvPath(paths ...string) error
• func Append(filename, text string) error
• func CheckDir(dir string) string
• func Copy(dstFile, srcFile string) (bool, error)
• func CopyDir(dst, src string)
• func DelEnvPath(paths ...string) error
• func EnvPath() []string
• func ExistPath(vpath string) bool
• func GetMemStatsRange() func() (runtime.MemStats, runtime.MemStats)
• func IsDir(dir string) bool
• func Put(filename, text string) error
• func StdDir(d 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 FsReaderWriter
  • func (f *FsReaderWriter) Error() string
  • func (f *FsReaderWriter) Read(p []byte) (n int, err error)
  • func (f *FsReaderWriter) Write(p []byte) (n int, err error)
• type MemUsage
  • func (m *MemUsage) GetSysMemSub() func() number.BitSize

Constants

const (
	DirScannerChanMax = 5000
)

const (
	VEnvPath = "path"
)

Functions

func AddEnvPath

func AddEnvPath(paths ...string) error

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 Copy

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

Copy copy file by io

func CopyDir

func CopyDir(dst, src string)

CopyDir copy all file in a dir

func DelEnvPath

func DelEnvPath(paths ...string) error

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 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 StdDir

func StdDir(d string) string

StdDir the standard dir format

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 FsReaderWriter

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

FsReaderWriter [Experimental] file read interface

func (*FsReaderWriter) Error

func (f *FsReaderWriter) Error() string

func (*FsReaderWriter) Read

func (f *FsReaderWriter) Read(p []byte) (n int, err error)

func (*FsReaderWriter) Write

func (f *FsReaderWriter) Write(p []byte) (n int, err error)

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