util

Documentation

Index

• Variables
• func CopyFile(src, dst string) (int64, error)
• func CopyFolder(source, dest string) error
• func CopyFolderWithFilter(source, dest string, includeFilter IncludeFilter) (err error)
• func ExeDir() (string, error)
• func ExecAndCaptureOutput(command string, args ...string) (string, string, error)
• func FileExists(filePath string) bool
• func FindProcess(pid int) (*os.Process, error)
• func GetCurrentProcessTimes() (utime int64, stime int64, err error)
• func GetFirstLineFromFile(netFile string) (string, error)
• func Getrusage(who int, rusage *syscall.Rusage) (err error)
• func IsDir(path string) bool
• func KillProcess(pid int, sig syscall.Signal) error
• func RunFuncWithSpinningCursor(asyncFunc func())
• func SetFdSoftLimit(newLimit uint64) error
• type IncludeFilter
• type WatchdogStreamReader
  • func MakeWatchdogStreamReader(underlayingReader io.Reader, readSize uint64, readaheadSize uint64, ...) WatchdogStreamReader

Variables

var ErrWatchdogStreamReaderReaderReachedDataLimit = fmt.Errorf("watchdog stream reader reached data limit")

ErrWatchdogStreamReaderReaderReachedDataLimit is returned when watchdogStreamReader was asked to read beyond the designated data limits

var ErrWatchdogStreamReaderTimerElapsed = fmt.Errorf("watchdog stream reader timer elapsed")

ErrWatchdogStreamReaderTimerElapsed is returned when the watchdogStreamReader was not reset in the past readaheadDuration and read was attempted

Functions

func CopyFile

func CopyFile(src, dst string) (int64, error)

CopyFile uses io.Copy() to copy a file to another location This was copied from https://opensource.com/article/18/6/copying-files-go

func CopyFolder

func CopyFolder(source, dest string) error

CopyFolder recursively copies an entire directory to another location (ignoring symlinks)

func CopyFolderWithFilter

func CopyFolderWithFilter(source, dest string, includeFilter IncludeFilter) (err error)

CopyFolderWithFilter recursively copies an entire directory to another location (ignoring symlinks) with an optional filter function to include/exclude folders or files

func ExeDir

func ExeDir() (string, error)

ExeDir returns the absolute path to the current executing binary (not including the filename)

func ExecAndCaptureOutput

func ExecAndCaptureOutput(command string, args ...string) (string, string, error)

ExecAndCaptureOutput runs the specified command and args and captures stdout into a string, returning the string or an error upon completion.

func FileExists

func FileExists(filePath string) bool

FileExists checks to see if the specified file (or directory) exists

func FindProcess

func FindProcess(pid int) (*os.Process, error)

FindProcess looks for a running process by its pid

func GetCurrentProcessTimes

func GetCurrentProcessTimes() (utime int64, stime int64, err error)

GetCurrentProcessTimes gets current process kernel and usermode times

func GetFirstLineFromFile

func GetFirstLineFromFile(netFile string) (string, error)

GetFirstLineFromFile retrieves the first line of the specified file.

func Getrusage

func Getrusage(who int, rusage *syscall.Rusage) (err error)

Getrusage gets file descriptors usage statistics

func IsDir

func IsDir(path string) bool

IsDir returns true if the specified directory is valid

func KillProcess

func KillProcess(pid int, sig syscall.Signal) error

KillProcess kills a running OS process

func RunFuncWithSpinningCursor

func RunFuncWithSpinningCursor(asyncFunc func())

RunFuncWithSpinningCursor runs a given function in a go-routine, while displaying a spinning cursor to the CLI

func SetFdSoftLimit

func SetFdSoftLimit(newLimit uint64) error

SetFdSoftLimit sets a new file descriptors soft limit.

Types

type IncludeFilter

type IncludeFilter func(name string, info os.FileInfo) bool

IncludeFilter is a callback for filtering files and folders encountered while copying with CopyFileWithFilter()

type WatchdogStreamReader

type WatchdogStreamReader interface {
	Reset() error
	Read(p []byte) (n int, err error)
	Close()
}

WatchdogStreamReader is the public interface for the watchdogStreamReader implementation.

func MakeWatchdogStreamReader

func MakeWatchdogStreamReader(underlayingReader io.Reader, readSize uint64, readaheadSize uint64, readaheadDuration time.Duration) WatchdogStreamReader

MakeWatchdogStreamReader creates a watchdogStreamReader and initializes it.