core

Documentation

Index

• Variables
• func ParseParam()
• type Exporter
• type Scanner
• type Setting
• type SortOpt
  • func WithFileType() SortOpt
  • func WithTimeSpan(timeSpan string) SortOpt
• type SortOptions
  • func NewSortOptions() *SortOptions
  • func (s *SortOptions) SortByFileType() bool
  • func (s *SortOptions) SortByTimeSpan() bool
  • func (s *SortOptions) TimeFormat() string
• type Sorter
• type Tidy

Variables

var (
	PathParam          string
	DirectoryNameParam string
	SortTypeParam      string
	TimeSpanParam      string
)

Functions

func ParseParam

func ParseParam()

Types

type Exporter

type Exporter interface {
	SetUp(setting *Setting)
	Export() error
}

type Scanner

type Scanner interface {
	SetUp(path string) error
	Scan() (*[]fs.DirEntry, error)
}

type Setting

type Setting struct {
	ImportPath    string
	SortedEntries map[string][]*fs.DirEntry `comment:"map key: timestamp ,for example '2006-01-02 15.04.05'; file_type ,for example:'docx' "`
	SortOptions   *SortOptions
}

type SortOpt

type SortOpt func(options *SortOptions)

func WithFileType

func WithFileType() SortOpt

func WithTimeSpan

func WithTimeSpan(timeSpan string) SortOpt

type SortOptions

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

func NewSortOptions

func NewSortOptions() *SortOptions

func (*SortOptions) SortByFileType

func (s *SortOptions) SortByFileType() bool

func (*SortOptions) SortByTimeSpan

func (s *SortOptions) SortByTimeSpan() bool

func (*SortOptions) TimeFormat

func (s *SortOptions) TimeFormat() string

type Sorter

type Sorter interface {
	SetUp(dirEntries *[]fs.DirEntry, options ...SortOpt)
	Sort() (map[string][]*fs.DirEntry, error)
}

type Tidy

type Tidy interface {
	Exec() error
}