package
0.0.0-20230421053604-b3f7bda99619
Repository: https://github.com/funbinary/go_example.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
Abs @Description: 使用filepath的ABS API,返回路径的绝对路径 @param path: 路径 @return string 路径的绝对路径
.
AppendBytes @Description: 以字节形式写入文件。如果文件不存在将会递归的形式自动创建 @param path 文件所在的路径 @param content 字节数组 @return error
.
AppendContents @Description: 以字符串形式写入文件,使用追加的方式。如果文件不存在将会递归的形式自动创建 @param path 文件所在的路径 @param content 字节数组 @return error
.
Basename @Description: 返回路径的最后一个元素,包含文件扩展名,如果path为空则返回.
Chdir @Description: 更改当前的工作路径 @param dir @return err
.
Chmod @Description: 修改权限 @param path @param mode @return err
.
Copy @Description: 拷贝文件和目录 @param src @param dst @return error
.
CopyDir @Description: 拷贝目录 @param src @param dst @return err
.
CopyFile @Description: 拷贝文件 @param src @param dst @return err
.
Create @Description: 创建文件,如果文件所在路径不存在,则会自动创建文件夹及文件,其权限为0666(任何人都可读写,不可执行)如果创建的文件已存在则会清空该文件的内容。 @param path: 文件路径 @return *os.File 文件指针 @return error
.
Dir @Description: @param path 路径 @return string 给定路径的目录部分
.
DirSubs @Description: 获取文件夹下所有文件和文件夹,非递归 @param path @return []string path下的文件和文件夹列表 @return error
.
Exists @Description: 判断路径是否存在 @param path 文件或者目录的路径 @return bool 如果文件或目录存在则返回true,否则返回false
.
Ext @Description: 获取给定路径的扩展名,包含.
ExtName @Description: 获取给定路径的扩展名,不包含.
FormatSize @Description: 将size转化成可读的文件大小 @param raw @return string
.
GetBytes @Description: 读取文件的内容 @param path 文件路径 @return []byte 文件内容
.
GetBytesByRange @Description: 读取指定区间的文件字节内容,左闭右开 @param reader 文件接口 @param start 起始偏移量 @param end 终止偏移量 @return []byte
.
GetBytesByRangesByPath @Description: 读取指定区间的文件字节内容,左闭右开 @param path 文件路径 @param start 起始偏移量 @param end 终止偏移量 @return []byte
.
GetBytesTilChar @Description: 从文件中截取start到char字符位置的文件内容,以字节形式返回 @param reader 文件接口 @param start 起始位置 @param char 字符 @return []byte @return int64 返回的字节数组数量
.
GetBytesTilCharByPath @Description: 从文件中截取start到char字符位置的文件内容,以字节形式返回 @param path 文件路径 @param start 起始位置 @param char 字符 @return []byte @return int64 返回的字节数组数量
.
GetCharFromOffset @Description: 从某个偏移量开始,获取文件中指定字符所在下标 @param reader 文件接口 @param char 要查找的字符 @param start 偏移量 @return int64 如果找到返回序号,如果找不到则返回-1
.
GetCharOffsetFromByPath @Description: 从某个偏移量开始,获取文件中指定字符所在下标 @param path 文件路径 @param char 要查找的字符 @param start 偏移量 @return int64 如果找到返回序号,如果找不到则返回-1
.
GetContents @Description: 读取文件的内容,并将其转为字符串 @param path 文件路径 @return string 文件内容
.
Glob @Description: 模糊搜索给定路径下的文件列表,支持正则,第二个参数控制返回的结果是否带上绝对路径。 @param pattern @param onlyNames 是否带上 @return []string @return error
.
Home @Description: 获取当前的Home目录 @param names @return string @return error
.
IsBinary @Description: 判断文件是否是二进制类型 @param path 文件路径 @return bool true - 文件为二进制类型
.
IsDir @Description: 判断路径是否是目录 @param path @return bool 当路径为目录时返回true,否则返回false
.
IsEmpty @Description: 判断文件或者目录是否为空 @param path @return bool 如果文件或目录为空将会返回true,否则返回false
.
IsFile @Description: 判断路径是否是文件 @param path @return bool 当路径为文件时返回true,否则返回false
.
IsReadable @Description: 判断文件/目录是否可读 @param path @return bool
.
IsWritable @Description: 判断文件或目录是否可写 @param path @return bool
.
Join @Description: 将多个字符串路径通过/进行拼接,windows为\ @param paths: 路径字符串 @return string 拼接后的字符串路径
.
Mkdir @Description: 递归创建目录 @param path 路径,建议使用绝对路径,不推荐使用相对路径 @return err 如果创建失败会返回错误的原因,否则返回nil
.
Move @Description: 將文件src移动到dst @param src @param dst @return err
.
MTime @Description: 获取文件的修改时间,返回时间类型 @param path @return time.Time
.
MTimestamp @Description: 获取文件的修改时间,返回unix时间类型,即int64 @param path @return int64
.
MTimestampMilli @Description: 获取文件的修改时间毫秒级别,返回unix时间类型,即int64 @param path @return int64
.
Name @Description: 返回当前程序名,不包含扩展名 @param path 路径 @return string 返回当前程序名,不包含扩展名
.
Open @Description: 以只读的方式打开文件 @param path @return *os.File @return error
.
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
.
Pwd @Description: 获取当前的工作目录 @return string
.
ReadableSize @Description: 获取路径大小,并格式化 @param path @return string
.
ReadLines @Description: 以字符串的形式逐行读取文件内容 @param file 文件名 @param callback @return error
.
ReadLinesBytes @Description:以字节形式逐行读取文件内容 @param file @param callback @return error
.
RealPath @Description: 返回绝对路径 @param path 文件或者目录的路径 @return string 如果文件/目录存在则返回绝对路径,否则返回空字符串
.
Remove @Description: 删除给定的文件或文件夹 @param path 给定文件或文件夹的路径 @return err
.
Rename @Description: 将文件/文件夹src重命名为dst @param src @param dst @return error
.
ReplaceDir @Description: 扫描文件路径,将符合条件的文件的指定内容替换为新内容
@param search 匹配的内容
@param replace 需要替代的字符串
@param path 文件路径
@param pattern 匹配的文件名
@param recursive 是否递归
@return error
.
ReplaceDirFunc @Description: 扫描指定目录,使用自定义函数替换符合条件的文件的指定内容为新内容
@param f
@param path 文件路径
@param pattern 匹配的文件名
@param recursive 是否递归
@return error
.
ReplaceFile @Description: 替换文件search的内容为replace @param search @param replace @param path @return error
.
ReplaceFileFunc @Description: 使用自定义的函数替换文件内容
@param f
@param path
@return error
.
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
.
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
.
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
.
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
.
SelfDir @Description: 获取当前程序所在的目录 @return string 当前程序所在的目录
.
SelfName @Description: 获取当前运行程序的名称 @return string 当前运行程序的名称
.
SelfPath @Description: 获取当前运行程序的路径,包含程序名 @return string 当前运行程序的路径
.
SetBytes @Description: 以字节形式写入文件。如果文件不存在将会递归的形式自动创建,如果文件有内容会被清空 @param path 文件所在的路径 @param content 字节数组 @return error
.
SetContents @Description: 往指定路径文件添加字符串内容。如果文件不存在将会递归的形式自动创建,如果文件有内容会被清空 @param path 文件所在的路径 @param content 要写入文件的内容 @return error
.
Size @Description: 获取路径的大小,不格式化 @param path @return int64
.
SizeFormat @Description: 获取路径大小,并格式化 @param path @return string
.
Stat @Description: 获取文件信息 @param path @return os.FileInfo @return error
.
StrToSize @Description: 将文件大小字符串转成int64 @param sizeStr @return int64
.
Truncate @Description: 将文件裁剪为指定大小 @param path 文件路径 @param size 截取的文件大小 @return err
.
# Constants
No description provided by the author
No description provided by the author
append data to the file when writing.
create a new file if none exists.
used with O_CREATE, file must not exist.
open the file read-only.
open the file read-write.
open for synchronous I/O.
truncate regular writable file when opened.
open the file write-only.
No description provided by the author
# Variables
默认读取缓冲区大小.