Documentation ¶
Index ¶
- Constants
- Variables
- func Abs(path string) string
- func AppendBytes(path string, content []byte) error
- func AppendContents(path string, content string) error
- func Basename(path string) string
- func Chdir(dir string) (err error)
- func Chmod(path string, mode os.FileMode) (err error)
- func Copy(src string, dst string) error
- func CopyDir(src string, dst string) (err error)
- func CopyFile(src, dst string) (err error)
- func Create(path string) (*os.File, error)
- func Dir(path string) string
- func DirSubs(path string) ([]string, error)
- func Exists(path string) bool
- func Ext(path string) string
- func ExtName(path string) string
- func FormatSize(raw int64) string
- func GetBytes(path string) []byte
- func GetBytesByRange(reader io.ReaderAt, start int64, end int64) []byte
- func GetBytesByRangesByPath(path string, start int64, end int64) []byte
- func GetBytesTilChar(reader io.ReaderAt, start int64, char byte) ([]byte, int64)
- func GetBytesTilCharByPath(path string, start int64, char byte) ([]byte, int64)
- func GetCharFromOffset(reader io.ReaderAt, char byte, start int64) int64
- func GetCharOffsetFromByPath(path string, char byte, start int64) int64
- func GetContents(path string) string
- func Glob(pattern string, onlyNames ...bool) ([]string, error)
- func Home(names ...string) (string, error)
- func IsBinary(path string) bool
- func IsDir(path string) bool
- func IsEmpty(path string) bool
- func IsFile(path string) bool
- func IsReadable(path string) bool
- func IsWritable(path string) bool
- func Join(paths ...string) string
- func MTime(path string) time.Time
- func MTimestamp(path string) int64
- func MTimestampMilli(path string) int64
- func Mkdir(path string) (err error)
- func Move(src string, dst string) (err error)
- func Name(path string) string
- func Open(path string) (*os.File, error)
- func OpenFile(path string, flag int, perm os.FileMode) (*os.File, error)
- func Pwd() string
- func ReadLines(file string, callback func(text string) error) error
- func ReadLinesBytes(file string, callback func(bytes []byte) error) error
- func ReadableSize(path string) string
- func RealPath(path string) string
- func Remove(path string) (err error)
- func Rename(src string, dst string) error
- func ReplaceDir(search, replace, path, pattern string, recursive ...bool) error
- func ReplaceDirFunc(f func(path, content string) string, path, pattern string, recursive ...bool) error
- func ReplaceFile(search, replace, path string) error
- func ReplaceFileFunc(f func(path, content string) string, path string) error
- func ScanDir(path string, pattern string, recursive ...bool) ([]string, error)
- func ScanDirFile(path string, pattern string, recursive ...bool) ([]string, error)
- func ScanDirFileFunc(path string, pattern string, recursive bool, handler func(path string) string) ([]string, error)
- func ScanDirFunc(path string, pattern string, recursive bool, handler func(path string) string) ([]string, error)
- func SelfDir() string
- func SelfName() string
- func SelfPath() string
- func SetBytes(path string, content []byte) error
- func SetContents(path string, content string) error
- func Size(path string) int64
- func SizeFormat(path string) string
- func Stat(path string) (os.FileInfo, error)
- func StrToSize(sizeStr string) int64
- func Truncate(path string, size int) (err error)
Constants ¶
View Source
const ( Separator = string(filepath.Separator) DefaultPermOpen = os.FileMode(0666) DefaultPermCopy = os.FileMode(0777) )
View Source
const ( // Exactly one of O_RDONLY, O_WRONLY, or O_RDWR must be specified. O_RDONLY int = os.O_RDONLY // open the file read-only. O_WRONLY int = os.O_WRONLY // open the file write-only. O_RDWR int = os.O_RDWR // open the file read-write. // The remaining values may be or'ed in to control behavior. O_APPEND int = os.O_APPEND // append data to the file when writing. O_CREATE int = os.O_CREATE // create a new file if none exists. O_EXCL int = os.O_EXCL // used with O_CREATE, file must not exist. O_SYNC int = os.O_SYNC // open for synchronous I/O. O_TRUNC int = os.O_TRUNC // truncate regular writable file when opened. )
Variables ¶
View Source
var (
// 默认读取缓冲区大小
DefaultReadBuffer = 1024
)
Functions ¶
func AppendBytes ¶
AppendBytes
@Description: 以字节形式写入文件。如果文件不存在将会递归的形式自动创建 @param path 文件所在的路径 @param content 字节数组 @return error
func AppendContents ¶
AppendContents
@Description: 以字符串形式写入文件,使用追加的方式。如果文件不存在将会递归的形式自动创建 @param path 文件所在的路径 @param content 字节数组 @return error
func Basename ¶
Basename
@Description: 返回路径的最后一个元素,包含文件扩展名,如果path为空则返回. @param path 路径 @return string 返回路径的最后一个元素,包含文件扩展名
func Create ¶
Create
@Description: 创建文件,如果文件所在路径不存在,则会自动创建文件夹及文件,其权限为0666(任何人都可读写,不可执行)如果创建的文件已存在则会清空该文件的内容。 @param path: 文件路径 @return *os.File 文件指针 @return error
func DirSubs ¶
DirSubs
@Description: 获取文件夹下所有文件和文件夹,非递归 @param path @return []string path下的文件和文件夹列表 @return error
func Exists ¶
Exists
@Description: 判断路径是否存在 @param path 文件或者目录的路径 @return bool 如果文件或目录存在则返回true,否则返回false
func GetBytesByRange ¶
GetBytesByRange
@Description: 读取指定区间的文件字节内容,左闭右开 @param reader 文件接口 @param start 起始偏移量 @param end 终止偏移量 @return []byte
func GetBytesByRangesByPath ¶
GetBytesByRangesByPath
@Description: 读取指定区间的文件字节内容,左闭右开 @param path 文件路径 @param start 起始偏移量 @param end 终止偏移量 @return []byte
func GetBytesTilChar ¶
GetBytesTilChar
@Description: 从文件中截取start到char字符位置的文件内容,以字节形式返回 @param reader 文件接口 @param start 起始位置 @param char 字符 @return []byte @return int64 返回的字节数组数量
func GetBytesTilCharByPath ¶
GetBytesTilCharByPath
@Description: 从文件中截取start到char字符位置的文件内容,以字节形式返回 @param path 文件路径 @param start 起始位置 @param char 字符 @return []byte @return int64 返回的字节数组数量
func GetCharFromOffset ¶
GetCharFromOffset
@Description: 从某个偏移量开始,获取文件中指定字符所在下标 @param reader 文件接口 @param char 要查找的字符 @param start 偏移量 @return int64 如果找到返回序号,如果找不到则返回-1
func GetCharOffsetFromByPath ¶
GetCharOffsetFromByPath
@Description: 从某个偏移量开始,获取文件中指定字符所在下标 @param path 文件路径 @param char 要查找的字符 @param start 偏移量 @return int64 如果找到返回序号,如果找不到则返回-1
func Glob ¶
Glob
@Description: 模糊搜索给定路径下的文件列表,支持正则,第二个参数控制返回的结果是否带上绝对路径。 @param pattern @param onlyNames 是否带上 @return []string @return error
func IsEmpty ¶
IsEmpty
@Description: 判断文件或者目录是否为空 @param path @return bool 如果文件或目录为空将会返回true,否则返回false
func Join ¶
Join
@Description: 将多个字符串路径通过/进行拼接,windows为\ @param paths: 路径字符串 @return string 拼接后的字符串路径
func MTimestampMilli ¶
MTimestampMilli
@Description: 获取文件的修改时间毫秒级别,返回unix时间类型,即int64 @param path @return int64
func Mkdir ¶
Mkdir
@Description: 递归创建目录 @param path 路径,建议使用绝对路径,不推荐使用相对路径 @return err 如果创建失败会返回错误的原因,否则返回nil
func OpenFile ¶
OpenFile
@Description: 以指定的flag和perm打开文件 @param path @param flag O_RDONLY、O_WRONLY、O_RDWR、O_APPEND、O_CREATE、O_EXCL、O_SYNC、O_TRUNC @param perm 0666、0777 @return *os.File @return error
func ReadLines ¶
ReadLines
@Description: 以字符串的形式逐行读取文件内容 @param file 文件名 @param callback @return error
func ReadLinesBytes ¶
ReadLinesBytes
@Description:以字节形式逐行读取文件内容 @param file @param callback @return error
func RealPath ¶
RealPath
@Description: 返回绝对路径 @param path 文件或者目录的路径 @return string 如果文件/目录存在则返回绝对路径,否则返回空字符串
func ReplaceDir ¶
ReplaceDir
@Description: 扫描文件路径,将符合条件的文件的指定内容替换为新内容 @param search 匹配的内容 @param replace 需要替代的字符串 @param path 文件路径 @param pattern 匹配的文件名 @param recursive 是否递归 @return error
func ReplaceDirFunc ¶
func ReplaceDirFunc(f func(path, content string) string, path, pattern string, recursive ...bool) error
ReplaceDirFunc
@Description: 扫描指定目录,使用自定义函数替换符合条件的文件的指定内容为新内容 @param f @param path 文件路径 @param pattern 匹配的文件名 @param recursive 是否递归 @return error
func ReplaceFile ¶
ReplaceFile
@Description: 替换文件search的内容为replace @param search @param replace @param path @return error
func ReplaceFileFunc ¶
ReplaceFileFunc
@Description: 使用自定义的函数替换文件内容 @param f @param path @return error
func ScanDir ¶
ScanDir
@Description: 扫描指定目录或文件,支持递归扫描 @param path @param pattern 支持多个匹配,可以使用,分割,其匹配语法 term: '*' 匹配0或多个非路径分隔符的字符 '?' 匹配1个非路径分割符的字符 '[' [ '^' ] { character-range } ']' 字符组,必须非空 c 匹配字符,字符不能是*、?、\\、[ '\\' c 匹配字符,支持*、?、\\、[ character-range: c 匹配字符,字符不能是\\、-、] '\\' c 匹配字符 lo '-' hi 匹配区间[lo,hi]的字符 匹配要求匹配整个name字符串,而不是它的一部分。 @param recursive true递归扫描,false不进行递归扫描 @return []string @return error
func ScanDirFile ¶
ScanDirFile
@Description: 扫描指定目录的文件,支持递归扫描 @param path @param pattern 支持多个匹配,可以使用,分割,其匹配语法 term: '*' 匹配0或多个非路径分隔符的字符 '?' 匹配1个非路径分割符的字符 '[' [ '^' ] { character-range } ']' 字符组,必须非空 c 匹配字符,字符不能是*、?、\\、[ '\\' c 匹配字符,支持*、?、\\、[ character-range: c 匹配字符,字符不能是\\、-、] '\\' c 匹配字符 lo '-' hi 匹配区间[lo,hi]的字符 匹配要求匹配整个name字符串,而不是它的一部分。 @param recursive true递归扫描,false不进行递归扫描 @param handler 自定义方法,每次搜索到文件或者目录将会调用此方法,如果返回的字符串为空此路径将会被过滤掉 @return []string @return error
func ScanDirFileFunc ¶
func ScanDirFileFunc(path string, pattern string, recursive bool, handler func(path string) string) ([]string, error)
ScanDirFileFunc
@Description: 扫描指定目录的文件,支持递归扫描 @param path @param pattern 支持多个匹配,可以使用,分割,其匹配语法 term: '*' 匹配0或多个非路径分隔符的字符 '?' 匹配1个非路径分割符的字符 '[' [ '^' ] { character-range } ']' 字符组,必须非空 c 匹配字符,字符不能是*、?、\\、[ '\\' c 匹配字符,支持*、?、\\、[ character-range: c 匹配字符,字符不能是\\、-、] '\\' c 匹配字符 lo '-' hi 匹配区间[lo,hi]的字符 匹配要求匹配整个name字符串,而不是它的一部分。 @param recursive true递归扫描,false不进行递归扫描 @return []string @return error
func ScanDirFunc ¶
func ScanDirFunc(path string, pattern string, recursive bool, handler func(path string) string) ([]string, error)
ScanDirFunc
@Description: 扫描指定目录或文件,支持递归扫描 @param path @param pattern 支持多个匹配,可以使用,分割,其匹配语法 term: '*' 匹配0或多个非路径分隔符的字符 '?' 匹配1个非路径分割符的字符 '[' [ '^' ] { character-range } ']' 字符组,必须非空 c 匹配字符,字符不能是*、?、\\、[ '\\' c 匹配字符,支持*、?、\\、[ character-range: c 匹配字符,字符不能是\\、-、] '\\' c 匹配字符 lo '-' hi 匹配区间[lo,hi]的字符
匹配要求匹配整个name字符串,而不是它的一部分。
@param recursive true递归扫描,false不进行递归扫描 @param handler 自定义方法,每次搜索到文件或者目录将会调用此方法,如果返回的字符串为空此路径将会被过滤掉 @return []string @return error
func SelfPath ¶
func SelfPath() string
SelfPath
@Description: 获取当前运行程序的路径,包含程序名 @return string 当前运行程序的路径
func SetBytes ¶
SetBytes
@Description: 以字节形式写入文件。如果文件不存在将会递归的形式自动创建,如果文件有内容会被清空 @param path 文件所在的路径 @param content 字节数组 @return error
func SetContents ¶
SetContents
@Description: 往指定路径文件添加字符串内容。如果文件不存在将会递归的形式自动创建,如果文件有内容会被清空 @param path 文件所在的路径 @param content 要写入文件的内容 @return error
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.