osutil

Documentation

Overview

Package osutil implements some OS utility functions.

Package osutil implements some OS utility functions.

Index

• func AbsFilepath(path string) (string, error)
• func CreateFileWithLines(filename string, lines []string, lineSuffix string, useBuffer bool) error
• func EmptyAll(name string) error
• func EnvExists(fields ...string) (missing []string, haveAll bool)
• func EnvFiltered(rx *regexp.Regexp) map[string]string
• func Exists(name string) (bool, error)
• func FileModAge(name string) (time.Duration, error)
• func FileModAgeFromInfo(fi os.FileInfo) time.Duration
• func FinfosToFilepaths(dir string, fis []os.FileInfo) []string
• func GetFileInfo(path string) (os.FileInfo, error)
• func UserGoSrcDir() (string, error)
• type EnvVar
  • func Env() []EnvVar
• type FileInfoMore
  • func NewFileInfoMoreFromPath(path string) (FileInfoMore, error)

Functions

func AbsFilepath

func AbsFilepath(path string) (string, error)

AbsFilepath returns an absolute filepath, using the user's current / home directory if indicated in the filepath string.

func CreateFileWithLines

func CreateFileWithLines(filename string, lines []string, lineSuffix string, useBuffer bool) error

CreateFileWithLines creates a file and writes lines to it. It will optionally add a `lineSuffix` (e.g. `"\n"`) and use `bufio`.

func EmptyAll

func EmptyAll(name string) error

EmptyAll will delete all contents of a directory, leaving the provided directory. This is different from os.Remove which also removes the directory provided.

func EnvExists

func EnvExists(fields ...string) (missing []string, haveAll bool)

func EnvFiltered

func EnvFiltered(rx *regexp.Regexp) map[string]string

EnvFiltered returns a map[string]string of environment variables that match a regular expression.

func Exists

func Exists(name string) (bool, error)

Exists checks whether the named filepath exists or not for a file or directory.

func FileModAge

func FileModAge(name string) (time.Duration, error)

FileModAge returns a time.Duration representing the age of the named file from FileInfo.ModTime().

func FileModAgeFromInfo

func FileModAgeFromInfo(fi os.FileInfo) time.Duration

FileModAgeFromInfo returns the file last modification age as a time.Duration.

func FinfosToFilepaths

func FinfosToFilepaths(dir string, fis []os.FileInfo) []string

FinfosToFilepaths returns a slice of string from a directory and sli=ce of `os.FileInfo`.

func GetFileInfo

func GetFileInfo(path string) (os.FileInfo, error)

GetFileInfo returns an os.FileInfo from a filepath.

func UserGoSrcDir

func UserGoSrcDir() (string, error)

Types

type EnvVar

type EnvVar struct {
	Key   string
	Value string
}

func Env

func Env() []EnvVar

type FileInfoMore

type FileInfoMore struct {
	FileInfo os.FileInfo
	ModAge   time.Duration
}

FileInfoMore provides a struct hold FileInfo with additional information.

func NewFileInfoMoreFromPath

func NewFileInfoMoreFromPath(path string) (FileInfoMore, error)

NewFileInfoMoreFromPath returns a FileInfoMore struct populatig both FileInfo and ModAge (last modification time).