fileshredder

README

fileshredder

概述

本库的目标是为了控制文件的生命周期，支持按照存活时间，目录下文件总大小，文件数量来控制。遍历文件顺序是按照文件最后修改时间从小到大。

使用

见 example

Documentation

Index

• type FileInfo
• type FileShredder
  • func NewFileShredder(opts ...Option) (*FileShredder, error)
  • func (f *FileShredder) Close() error
  • func (f *FileShredder) MillRunOnce(opts ...MillRunOnceOption) error
  • func (f *FileShredder) Run(ctx context.Context) error
• type IsNotDeleteFunc
• type MillRunOnceOption
  • func IsNotDelete(fn IsNotDeleteFunc) MillRunOnceOption
• type MillRunOnceOptions
  • func NewMillRunOnceOptions() MillRunOnceOptions
• type Option
  • func GlobPath(path string) Option
  • func Interval(d time.Duration) Option
  • func MaxAge(age time.Duration) Option
  • func MaxCount(count int64) Option
  • func MaxSize(size int64) Option
• type Options

Types

type FileInfo

type FileInfo struct {
	fs.FileInfo
	Path string
}

type FileShredder

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

func NewFileShredder

func NewFileShredder(opts ...Option) (*FileShredder, error)

func (*FileShredder) Close

func (f *FileShredder) Close() error

func (*FileShredder) MillRunOnce

func (f *FileShredder) MillRunOnce(opts ...MillRunOnceOption) error

func (*FileShredder) Run

func (f *FileShredder) Run(ctx context.Context) error

type IsNotDeleteFunc

type IsNotDeleteFunc func(info *FileInfo) bool

type MillRunOnceOption

type MillRunOnceOption func(*MillRunOnceOptions)

func IsNotDelete

func IsNotDelete(fn IsNotDeleteFunc) MillRunOnceOption

type MillRunOnceOptions

type MillRunOnceOptions struct {
	IsNotDelete IsNotDeleteFunc
}

func NewMillRunOnceOptions

func NewMillRunOnceOptions() MillRunOnceOptions

type Option

type Option func(*Options)

func GlobPath

func GlobPath(path string) Option

func Interval

func Interval(d time.Duration) Option

func MaxAge

func MaxAge(age time.Duration) Option

func MaxCount

func MaxCount(count int64) Option

func MaxSize

func MaxSize(size int64) Option

type Options

type Options struct {
	MaxAge   time.Duration
	MaxCount int64
	MaxSize  int64
	GlobPath string
	Interval time.Duration
}