Documentation
¶
Index ¶
- Constants
- func AssertExist(path string) error
- func AssertExistAndIsDir(path string) error
- func AssertExistAndIsFile(path string) error
- func AssertNotExistOrIsDir(path string) error
- func AssertNotExistOrIsFile(path string) error
- func CloseOnExec(f *os.File)
- func CopyDir(src, dest string) error
- func CopyFile(src, dest string) (int64, error)
- func CreateHardLink(src, dest string) error
- func CreateSoftLink(src, dest string) error
- func Delete(path string) error
- func EmptyDir(dirPath string) error
- func Exist(path string) bool
- func GetDirSize(dirPath string) (int64, error)
- func GetFileInfo(path string) (os.FileInfo, error)
- func GetFileSize(filePath string) (int64, error)
- func GetLuaContent(path string) (string, error)
- func GetModificationTime(path string) (time.Time, error)
- func GetName(nameOrPath string) string
- func GetPrefix(nameOrPath string) string
- func GetSize(path string) (int64, error)
- func GetSuffix(nameOrPath string) string
- func GetSuffixWithoutDot(nameOrPath string) string
- func IsDir(path string) bool
- func IsFile(path string) bool
- func IsHidden(path string) (bool, error)
- func MkDirs(dirPaths ...string) (err error)
- func MkParentDirs(paths ...string) (err error)
- func NewFile(filePath string) (*os.File, error)
- func NewTemporaryFile(dirPath, pattern string) (*os.File, error)
- func NotExist(path string) bool
- func Open(path string) (*os.File, error)
- func ReadFile(filePath string) ([]byte, error)
- func ReadFileToBase64(filePath string) (string, error)
- func Rename(oldPath, newPath string) error
- func SetModificationTime(path string, t time.Time) error
- func WriteToFile(data []byte, dest string) error
Constants ¶
const ( // PathSeparator 路径分隔符，Mac("/") PathSeparator = string(os.PathSeparator) PathSeparatorRune rune = os.PathSeparator // PathListSeparator 路径列表分隔符，Mac(":") PathListSeparator = string(os.PathListSeparator) PathListSeparatorRune rune = os.PathListSeparator )
Variables ¶
This section is empty.
Functions ¶
func CloseOnExec ¶
CloseOnExec makes sure closing the file on process forking.
参考: go-zero中 fs.CloseOnExec.
func CopyDir ¶
CopyDir 将 src目录的所有内容 复制到 dest目录 中.
PS: (1) src目录下如果还有目录，会递归（空目录也会复制过去）； (2) 类似于Linux的 cp -r 命令.
@param src 一个已经存在的目录 @param dest 一个已经存在的目录 || 一个不存在的目录
func CopyFile ¶
CopyFile 复制单个文件.
@param src 一个已经存在的文件 @param dest 一个已经存在的文件（会覆盖） || 一个不存在的文件 @return 第一个返回值: the number of bytes copied（单位为byte）
func CreateHardLink ¶
CreateHardLink 创建软链接
Golang 之 文件硬连接 与 软连接: https://blog.csdn.net/icebergliu1234/article/details/109208030
@param src 源文件 @param dest 生成链接的位置
func CreateSoftLink ¶
CreateSoftLink 创建软链接
Golang 之 文件硬连接 与 软连接: https://blog.csdn.net/icebergliu1234/article/details/109208030
@param src 源文件 @param dest 生成链接的位置
func Delete ¶
Delete 删除 文件 或 目录（内部有文件或目录，也会一并删除）.
@param path 文件（或目录）的路径（绝对 || 相对），可以不存在，此时将返回nil
PS: (1) 传参path可以为"": 正常执行，返回nil； (2) path对应的文件或目录不存在: 正常执行，返回nil； (3) Windows系统，如果 传参path 对应的是 一个被锁定的文件 或者 一个目录（内部有文件被锁定），将返回error（remove xxx(path): The process cannot access the file because it is being used by another process.）.
func GetDirSize ¶
GetDirSize 获取目录的大小（包含其内文件和目录）.
参考: golang获取文件/目录（包含下面的文件）的大小: https://blog.csdn.net/n_fly/article/details/117080173
func GetModificationTime ¶
GetModificationTime 获取文件（或目录）的修改时间
@param path 传参""将返回err（Stat : The system cannot find the path specified.）
func GetName ¶
GetName 获取文件（或目录）的名称（带后缀）.
PS: (1) 文件可以不存在； (2) 不要使用 path.Base()，不然在Windows环境下有问题.
@param pathOfFile 文件名 或 路径（相对||绝对）
e.g. ("") => "." (" ") => " "（1个空格） (" ") => " "（2个空格） (".") => "." ("./") => "." ("../") => ".."
e.g.1 ("test.log") => "test.log" (""/Users/richelieu/Downloads"") => "Downloads" ("c:/a/c/aaa.doc") => "aaa.doc"
e.g.2 ("/Users/richelieu/START") => "START" ("/Users/richelieu/START/") => "START"
func GetPrefix ¶
GetPrefix 文件名前缀 * PS: 文件可以不存在. 参考：https://zhuanlan.zhihu.com/p/80403583
@param pathOfFile 文件名 或 文件路径（相对||绝对）
e.g. "d:/t/test.log" => "test" "d:/t/test" => "test"
func GetSuffix ¶
GetSuffix 返回文件名后缀（带"."; 小写）
PS: 文件可以不存在.
@param pathOfFile 文件名 或 文件路径（相对||绝对）
e.g. ("d:/t/test.LOG") => ".log" ("d:/t/test") => ""
func IsHidden ¶
IsHidden 文件（或目录）是否隐藏？
如何在 Go 中检测文件夹中的隐藏文件 - 跨平台方法
https://www.likecs.com/ask-919454.html#sc=1368.5
流程: (1) 获取文件名（以防传参为路径） (2) 判断文件名是否以"."开头
PS: (1) 传参path 对应的文件或目录必须存在，否则返回error.
@param 文件（或目录）的 path 或 name
func MkDirs ¶
MkDirs 为目录路径，创建（一级或多级）目录.
PS: (1) 如果目录已经存在，将返回nil； (2) 如果 传参dirPath 对应的是个已存在的文件，将返回error（"mkdir {xxx}: not a directory"）.
@param dirPaths 目录路径s（相对路径 || 绝对路径）
e.g. ("i:/test/test.exe") => 路径没问题且目录不存在的情况下，会在i盘创建"test"、"test.exe"两个目录 ("i:/test1/test2/") => 路径没问题且目录不存在的情况下，会在i盘创建"test1"、"test2"两个目录
e.g.1 Mac ("") => nil（什么都不会做） ("/") => nil（什么都不会做） (".") => nil（什么都不会做） ("./") => nil（什么都不会做）
func MkParentDirs ¶
MkParentDirs 为父路径，创建（一级或多级）目录.
@param filePaths （文件 || 目录）路径s（相对路径 || 绝对路径）
e.g. ("") => nil (".") => nil
func NewTemporaryFile ¶
NewTemporaryFile 在指定目录下，生成临时文件.
@param dirPath 如果为""，临时文件将生成在 系统临时目录 内；如果为"."，临时文件将生成在 当前目录 内.
e.g. pattern: "tempfile_test" => 临时文件的文件名: "tempfile_test2594316144" pattern: "tempfile_test*" => 临时文件的文件名: "tempfile_test827818253" pattern: "tempfile_test*.xyz" => 临时文件的文件名: "tempfile_test3617672388.xyz"
func Open ¶
Open 以"只读权限"打开文件（或目录）.
@param path 文件（或目录）的路径
PS: (1) 对于os.Open()，如果传参对应的文件不存在，将返回error. (2) os.Open() 是以"只读"权限打开.
func ReadFile ¶
ReadFile 读取文件的数据.
PS: (1) ioutil.ReadFile() 比 ioutil.ReadAll() 性能好，特别是大文件； (2) 编码必须为"UTF-8"！！！
@param path 文件的路径（不能是目录的路径）
func ReadFileToBase64 ¶
ReadFileToBase64
!!!: 如果想实现: 图片 => base64字符串，请使用 imageKit.ConvertImageToBase64().
func Rename ¶
Rename 重命名文件（或目录）
PS: (1) 重命名的同时，也能 将该文件移动到别的目录下； (2) 重命名目录，该目录下 有没有文件或目录 不会有影响，正常能成功； (3) 重命名文件，如果 newPath 对应的是一个已经存在的文件，将覆盖那个文件（并不是加到最后面）； (4) 不管 oldPath，如果 newPath 对应的是一个已经存在的目录，将返回error(e.g. rename /Users/richelieu/Downloads/1 /Users/richelieu/Downloads/2: file exists).
func SetModificationTime ¶
SetModificationTime 修改文件（或目录）的修改时间
PS: (1) 也会同时修改文件（或目录）的访问时间； (2) 修改目录的修改时间，将不会影响该目录下的文件或目录； (3) 传参t可以晚于当前时间.
@param path 传参""将返回error（chtimes : The system cannot find the path specified.）
func WriteToFile ¶
WriteToFile 将数据（字节流）写到文件中.
@param dest 目标文件的路径（不存在的话，会创建一个新的文件；存在且是个文件的话，会覆盖掉旧的（并不会加到该文件的最后面））
Types ¶
This section is empty.
Source Files