xfile

README

xfile

介绍

• 文件处理

Documentation

Index

• func AppendContent(path string, content string) (int, error)
• func CopyFile(src, dst string, isFirstDel ...bool) (err error)
• func Create(path string) (*os.File, error)
• func CronParseLogFile(collectLog string, offset ...int) ([]string, error)
• func Exists(path string) bool
• func GetContent(path string) (string, error)
• func GetProjectDir(projectName string) string
• func Open(path string) (*os.File, error)
• func OpenFile(path string, flag int, perm os.FileMode) (*os.File, error)
• func ParseFileFormat(fileName string) string
• func PutContent(path string, content string) (int, error)
• func Remove(path string) error
• func SetLogger(l Logger)
• type FileHandle
  • func NewFileHandle(path string, expire ...time.Time) *FileHandle
  • func (fh *FileHandle) AppendContent(content string) (int, error)
  • func (fh *FileHandle) Clean() error
  • func (fh *FileHandle) Close() error
  • func (fh *FileHandle) Exists() bool
  • func (fh *FileHandle) GetContent() (string, error)
  • func (fh *FileHandle) GetFile(flag ...int) *os.File
  • func (fh *FileHandle) Initf(flag int, perm ...os.FileMode) error
  • func (fh *FileHandle) IsExpire() bool
  • func (fh *FileHandle) PutContent(content string) (int, error)
  • func (fh *FileHandle) ResetSeek(seekFlag ...int) (int64, error)
• type FilePool
  • func NewFilePool(size ...int) *FilePool
  • func (fp *FilePool) Close()
  • func (fp *FilePool) Get(path string, flag int, perm ...os.FileMode) (*FileHandle, error)
  • func (fp *FilePool) GetFile2Open(fh *FileHandle) int
  • func (fp *FilePool) GetFile2OpenMap() map[string]int
  • func (fp *FilePool) MaxFhCount(count int) *FilePool
  • func (fp *FilePool) Print(is bool) *FilePool
  • func (fp *FilePool) Put(fh *FileHandle, expire ...time.Time)
• type Logger

Functions

func AppendContent

func AppendContent(path string, content string) (int, error)

AppendContent 向文件里追加内容

func CopyFile

func CopyFile(src, dst string, isFirstDel ...bool) (err error)

CopyFile 复制文件

func Create

func Create(path string) (*os.File, error)

Create 可以新建文件/目录 注: 需要外部调用 Close 进行关闭

func CronParseLogFile

func CronParseLogFile(collectLog string, offset ...int) ([]string, error)

CronParseLogFile 定时解析增量 log, 返回每行的内容

func Exists

func Exists(path string) bool

Exists 判断文件/目录是否存在

func GetContent

func GetContent(path string) (string, error)

GetContent 获取文件内容

func GetProjectDir

func GetProjectDir(projectName string) string

GetProjectDir 获取项目路径

func Open

func Open(path string) (*os.File, error)

Open

func OpenFile

func OpenFile(path string, flag int, perm os.FileMode) (*os.File, error)

OpenFile

func ParseFileFormat

func ParseFileFormat(fileName string) string

ParseFileFormat 解析文件格式

func PutContent

func PutContent(path string, content string) (int, error)

PutContents 向文件里追加内容

func Remove

func Remove(path string) error

Remove 移除

func SetLogger

func SetLogger(l Logger)

SetLogger 设置 log

Types

type FileHandle

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

FileHandle

func NewFileHandle

func NewFileHandle(path string, expire ...time.Time) *FileHandle

NewFileHandle

func (*FileHandle) AppendContent

func (fh *FileHandle) AppendContent(content string) (int, error)

AppendContent 向文件写入内容, 内容追加

func (*FileHandle) Clean

func (fh *FileHandle) Clean() error

Clean 清空文件内容

func (*FileHandle) Close

func (fh *FileHandle) Close() error

Close 关闭文件句柄

func (*FileHandle) Exists

func (fh *FileHandle) Exists() bool

Exists 判断文件存在不

func (*FileHandle) GetContent

func (fh *FileHandle) GetContent() (string, error)

GetContent 查询内容

func (*FileHandle) GetFile

func (fh *FileHandle) GetFile(flag ...int) *os.File

GetFile 获取文件操作句柄

func (*FileHandle) Initf

func (fh *FileHandle) Initf(flag int, perm ...os.FileMode) error

Initf 初始化文件句柄

func (*FileHandle) IsExpire

func (fh *FileHandle) IsExpire() bool

IsExpire 过期

func (*FileHandle) PutContent

func (fh *FileHandle) PutContent(content string) (int, error)

PutContent 向文件里写内容, 只会覆写

func (*FileHandle) ResetSeek

func (fh *FileHandle) ResetSeek(seekFlag ...int) (int64, error)

ResetSeek 重置油标

type FilePool

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

FilePool 文件池

func NewFilePool

func NewFilePool(size ...int) *FilePool

NewFilePool 初始化文件池, 最大 256 个 默认会按 defaultExpireDur 进行淘汰 注: 使用结束需要调用 Close 释放还在内存中的句柄

func (*FilePool) Close

func (fp *FilePool) Close()

Close 关闭

func (*FilePool) Get

func (fp *FilePool) Get(path string, flag int, perm ...os.FileMode) (*FileHandle, error)

Get 获取文件句柄; 如果不存在就会新打开文件句柄; 如果文件/目录不存在会自动创建 注: 1. 调用完需要调用 Put 才能进行复用, 同时句柄不能 Close

2. 如果打算不用了的话, 必须调用 *FileHandle.Close 方法进行释放句柄, 防止内存泄露

func (*FilePool) GetFile2Open

func (fp *FilePool) GetFile2Open(fh *FileHandle) int

GetFile2Open 获取文件对应的文件句柄打开数

func (*FilePool) GetFile2OpenMap

func (fp *FilePool) GetFile2OpenMap() map[string]int

GetFile2OpenMap 获取池中所有文件打开的句柄数

func (*FilePool) MaxFhCount

func (fp *FilePool) MaxFhCount(count int) *FilePool

MaxFhCount 设置相同 path 时, 最大文件句柄数

func (*FilePool) Print

func (fp *FilePool) Print(is bool) *FilePool

Print 是否打印 log level 为 info 的 log

func (*FilePool) Put

func (fp *FilePool) Put(fh *FileHandle, expire ...time.Time)

Put 归还

type Logger

type Logger interface {
	Info(v ...interface{})
	Infof(format string, v ...interface{})
	Error(v ...interface{})
	Errorf(format string, v ...interface{})
}