module

Documentation

Index

• func Execute(path string, fs afero.Fs, p out.Printer, modules ...Module)
• type Context
  • func NewContext(top int, rr bool, root string) *Context
• type Module
  • func NewAggregateFileModule(ctx *Context, order int) Module
  • func NewBenfordFileModule(ctx *Context, order int) Module
  • func NewDetailFileModule(ctx *Context, order int, enabledRanges []int) Module
  • func NewExtensionModule(ctx *Context, order int) Module
  • func NewFoldersModule(ctx *Context, order int) Module
  • func NewTopFilesModule(ctx *Context, order int) Module
  • func NewTotalModule(ctx *Context, order int) Module
• type Range
  • func NewRange(min int64, max int64) *Range
  • func (r *Range) Contains(num int64) bool
  • func (r *Range) Count() int64
  • func (r *Range) Equal(y rbtree.Comparable) bool
  • func (r *Range) Less(y rbtree.Comparable) bool
  • func (r *Range) Size() int64
  • func (r *Range) String() string

Functions

func Execute

func Execute(path string, fs afero.Fs, p out.Printer, modules ...Module)

Execute runs modules over path specified

Types

type Context

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

Context defines modules context

func NewContext

func NewContext(top int, rr bool, root string) *Context

NewContext creates new module's context that needed to create new modules

type Module

type Module interface {
	// contains filtered or unexported methods
}

Module defines working modules interface

func NewAggregateFileModule

func NewAggregateFileModule(ctx *Context, order int) Module

NewAggregateFileModule creates new total file statistic module

func NewBenfordFileModule

func NewBenfordFileModule(ctx *Context, order int) Module

NewBenfordFileModule creates new file size bendford statistic

func NewDetailFileModule

func NewDetailFileModule(ctx *Context, order int, enabledRanges []int) Module

NewDetailFileModule creates new file statistic by file size range module

func NewExtensionModule

func NewExtensionModule(ctx *Context, order int) Module

NewExtensionModule creates new file extensions statistic module

func NewFoldersModule

func NewFoldersModule(ctx *Context, order int) Module

NewFoldersModule creates new folders module

func NewTopFilesModule

func NewTopFilesModule(ctx *Context, order int) Module

NewTopFilesModule creates new top files statistic module

func NewTotalModule

func NewTotalModule(ctx *Context, order int) Module

NewTotalModule creates new total statistic module

type Range

type Range struct {
	// Min value
	Min int64

	// Max value
	Max int64
	// contains filtered or unexported fields
}

Range defined integer value range

func NewRange

func NewRange(min int64, max int64) *Range

NewRange creates new *Range

func (*Range) Contains

func (r *Range) Contains(num int64) bool

Contains defines whether the number specified within range

func (*Range) Count

func (r *Range) Count() int64

Count gets the number of files that match the Range

func (*Range) Equal

func (r *Range) Equal(y rbtree.Comparable) bool

Equal gets whether value specified equal current value

func (*Range) Less

func (r *Range) Less(y rbtree.Comparable) bool

Less gets whether value specified less then current value

func (*Range) Size

func (r *Range) Size() int64

Size gets total size of all files that match the Range

func (*Range) String

func (r *Range) String() string