gfx

README

gfx

Golang文件操作扩展库，包含工作和生活中关于文件操作的各种有用的使用方法，包括

• 更友好的API
• 文件创建
• 文件删除
• 文件复制
• 一切皆可配置
  • 文件名
  • 扩展名
  • 文件名匹配模式
  • 匹配方法

感谢

Documentation

Index

• Constants
• func All(dir string, opts ...walkOption) (filenames []string, err error)
• func Copy(from string, to string, opts ...copyOption) (err error)
• func Create(path string, opts ...option) (err error)
• func Delete(filename string) error
• func Dir() *optionType
• func Exists() *builder.Exists
• func File() *optionType
• func Is(path string, opts ...isOption) (is bool, err error)
• func List() *builder.List
• func Matchable(matchable matchable) *optionMatchable
• func Mode(mode os.FileMode) *optionMode
• func Move(from string, to string) error
• func Name(path string, opts ...nameOption) (filename string)
• func NewName(original string) (new string)
• func NewOptions(opts ...option) []option
• func NewOwner(uid int, gid int) *owner
• func NewWalkOptions(opts ...walkOption) []walkOption
• func Path(path string) *optionPaths
• func Paths(paths ...string) *optionPaths
• func Pattern(pattern string) *optionPattern
• func Prefix(prefix string) *optionPrefix
• func Regexp(regex string) *optionRegexp
• func Rename(from string, to string) (err error)
• func Source(source string) *optionSource
• func Suffix(suffix string) *optionSuffix
• func Type(_type _type) *optionType
• func Unzip(source string, target string) (err error)
• func ValidFilename(filename string) bool
• func ValidFilepath(filepath string) bool
• func Walk(dir string, handler walkHandler, opts ...walkOption) (err error)
• func Watch(path string, watcher Watcher) (err error)
• func WriteMode(mode writeMode) *optionWriteMode
• func Zip(target string, source string, opts ...zipOption) (err error)
• type Watcher

Constants

const (
	// TypeFile 文件
	TypeFile _type = 1
	// TypeDir 目录
	TypeDir _type = 2
)

const (
	// WriteModeSkip 跳过
	WriteModeSkip writeMode = 1
	// WriteModeOverride 覆盖
	WriteModeOverride writeMode = 2
	// WriteModeError 返回错误
	WriteModeError writeMode = 3
	// WriteModeRename 重命名
	WriteModeRename writeMode = 4
)

Functions

func All

func All(dir string, opts ...walkOption) (filenames []string, err error)

All 取得目录下所有文件，包含子目录 默认文件匹配所有文件

func Copy

func Copy(from string, to string, opts ...copyOption) (err error)

Copy 文件复制 如果文件有冲突，默认使用覆盖模式

func Create

func Create(path string, opts ...option) (err error)

Create 创建文件或者目录 默认创建文件 默认权限是0777

func Delete

func Delete(filename string) error

Delete 删除文件或者目录

func Dir

func Dir() *optionType

func Exists

func Exists() *builder.Exists

Exists 判断是否存在

func File

func File() *optionType

File 配置类型为文件

func Is

func Is(path string, opts ...isOption) (is bool, err error)

Is 判断所给路径是否为文件或者目录

func List

func List() *builder.List

List 列出所有文件

func Matchable

func Matchable(matchable matchable) *optionMatchable

Matchable 配置文件是否可被浏览

func Mode

func Mode(mode os.FileMode) *optionMode

Mode 配置权限

func Move

func Move(from string, to string) error

Move 移动文件

func Name

func Name(path string, opts ...nameOption) (filename string)

Name 获得文件名称

func NewName

func NewName(original string) (new string)

NewName 新文件名，在避免文件名冲突的情况下

func NewOptions

func NewOptions(opts ...option) []option

NewOptions 暴露给外部使用的快捷方法

func NewOwner

func NewOwner(uid int, gid int) *owner

NewOwner 创建拥有者

func NewWalkOptions

func NewWalkOptions(opts ...walkOption) []walkOption

NewWalkOptions 暴露给外部使用的快捷方法

func Path

func Path(path string) *optionPaths

Path 路径

func Paths

func Paths(paths ...string) *optionPaths

Paths 路径列表

func Pattern

func Pattern(pattern string) *optionPattern

Pattern 模式匹配

func Prefix

func Prefix(prefix string) *optionPrefix

Prefix 前缀

func Regexp

func Regexp(regex string) *optionRegexp

Regexp 正则匹配

func Rename

func Rename(from string, to string) (err error)

Rename 重命名文件或者目录

func Source

func Source(source string) *optionSource

Source 源文件

func Suffix

func Suffix(suffix string) *optionSuffix

Suffix 以什么结束

func Type

func Type(_type _type) *optionType

Type 配置类型

func Unzip

func Unzip(source string, target string) (err error)

Unzip 解压

func ValidFilename

func ValidFilename(filename string) bool

ValidFilename 有效文件名（Windows标准）

func ValidFilepath

func ValidFilepath(filepath string) bool

ValidFilepath 有效文件夹名

func Walk

func Walk(dir string, handler walkHandler, opts ...walkOption) (err error)

Walk 浏览目录 默认文件匹配所有文件

func Watch

func Watch(path string, watcher Watcher) (err error)

func WriteMode

func WriteMode(mode writeMode) *optionWriteMode

WriteMode 配置复制模式

func Zip

func Zip(target string, source string, opts ...zipOption) (err error)

Zip 压缩

Types

type Watcher

type Watcher interface {
	// OnCreated 当文件被创建
	OnCreated(path string)

	// OnChanged 文件发生改变时
	OnChanged(path string)

	// OnDeleted 文件被删除时
	OnDeleted(path string)

	// OnRenamed 文件被重命名时
	OnRenamed(path string)

	// OnPermissionChanged 文件权限改变时
	OnPermissionChanged(path string)

	// OnError 当发生错误时
	OnError(err error)
}

Watcher 文件监控