gnsys

README

Package gnsys

A helper package for filesystem operations

Documentation

Index

• func CleanDir(dir string) error
• func ConvertTilda(path string) (string, error)
• func DirExists(path string) (exists bool, empty bool, err error)
• func Download(url, destDir string, showProgress bool) (string, error)
• func FileExists(f string) (bool, error)
• func IsDir(path string) bool
• func IsFile(path string) bool
• func MakeDir(dir string) error
• func Ping(host string, seconds int) bool
• type DirState
  • func GetDirState(dir string) DirState
  • func (d DirState) String() string

Functions

func CleanDir

func CleanDir(dir string) error

CleanDir removes all files from a directory or creates the directory if it is absent.

func ConvertTilda

func ConvertTilda(path string) (string, error)

ConvertTilda expands paths with `~/` to an actual home directory.

func DirExists

func DirExists(path string) (exists bool, empty bool, err error)

DirExists checks if directory exists and if it is empty

func Download

func Download(url, destDir string, showProgress bool) (string, error)

Download copies remote file to local drive. It provides the name of downloaded file and error as output.

func FileExists

func FileExists(f string) (bool, error)

FileExists checks if a file exists, and that it is a regular file.

func IsDir

func IsDir(path string) bool

func IsFile

func IsFile(path string) bool

func MakeDir

func MakeDir(dir string) error

MakeDir a directory out of a given unless it already exists.

func Ping

func Ping(host string, seconds int) bool

Ping checks if a server is reachable. Host should be in format "host:port" (eg "google.com:80")

Types

type DirState

type DirState int

DirState represents the state of a directory.

const (
	Unknown DirState = iota
	NotDir
	DirAbsent
	DirEmpty
	DirNotEmpty
)

func GetDirState

func GetDirState(dir string) DirState

GetDirState returns the state of a directory.

func (DirState) String

func (d DirState) String() string

String returns a string representation of the DirState.