module

Documentation

Index

• func Execute(path string, fs afero.Fs, w io.Writer, modules ...Module)
• type Context
  • func NewContext(top int) *Context
• type Module
  • func NewAggregateFileModule(ctx *Context) Module
  • func NewDetailFileModule(enabledRanges []int) Module
  • func NewExtensionModule(ctx *Context, hideOutput bool) Module
  • func NewFoldersModule(ctx *Context, hideOutput bool) Module
  • func NewTopFilesModule(ctx *Context) Module
  • func NewTotalModule(ctx *Context) Module
• type Range
  • func (r *Range) Contains(num int64) bool
• type Runner

Functions

func Execute

func Execute(path string, fs afero.Fs, w io.Writer, 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) *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) Module

NewAggregateFileModule creates new total file statistic module

func NewDetailFileModule

func NewDetailFileModule(enabledRanges []int) Module

NewDetailFileModule creates new file statistic by file size range module

func NewExtensionModule

func NewExtensionModule(ctx *Context, hideOutput bool) Module

NewExtensionModule creates new file extensions statistic module

func NewFoldersModule

func NewFoldersModule(ctx *Context, hideOutput bool) Module

NewFoldersModule creates new folders module

func NewTopFilesModule

func NewTopFilesModule(ctx *Context) Module

NewTopFilesModule creates new top files statistic module

func NewTotalModule

func NewTotalModule(ctx *Context) Module

NewTotalModule creates new total statistic module

type Range

type Range struct {
	// Min value
	Min int64

	// Max value
	Max int64
}

Range defined integer value range

func (*Range) Contains

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

Contains defines whether the number specified within range

type Runner

type Runner func(path string, fs afero.Fs, w io.Writer, modules ...Module)

Runner defines executable function prototype