sys

Documentation

Index

• func RunUnderWindows() bool
• func Scan(path string, fs afero.Fs, handlers []ScanHandler)
• type FileEntry
• type FolderEntry
• type ScanEvent
• type ScanHandler

Functions

func RunUnderWindows

func RunUnderWindows() bool

RunUnderWindows gets whether code running under Microsoft Windows

func Scan

func Scan(path string, fs afero.Fs, handlers []ScanHandler)

Scan do specified path scanning and executes folder handler on each folder and all file handlers on each file

Types

type FileEntry

type FileEntry struct {
	// File size in bytes
	Size int64

	// Full path
	Path string
}

FileEntry represent file description

type FolderEntry

type FolderEntry struct {
	FileEntry

	// The number of files in a folder
	Count int64
}

FolderEntry represent folder description

type ScanEvent

type ScanEvent struct {
	// File set not nil in case of file event occurred
	File *FileEntry

	// Folder set not nil in case of folder event occurred
	Folder *FolderEntry
}

ScanEvent defines scanning event structure that can contain file or folder event information

type ScanHandler

type ScanHandler func(f *ScanEvent)

ScanHandler defines function prototype that handles each file event received