Documentation
¶
Overview ¶
Package osutil implements some OS utility functions.
Package osutil implements some OS utility functions.
Index ¶
- Constants
- Variables
- func AbsFilepath(path string) (string, error)
- func CloseFileWithError(file *os.File, err error) error
- func CopyFile(src, dst string) error
- func CreateFileWithLines(filename string, lines []string, lineSuffix string, useBuffer bool) error
- func DirFromPath(path string) (string, error)
- func DirRemoveAllChildren(dir string) error
- func EmptyAll(name string) error
- func EnvExists(fields ...string) (missing []string, haveAll bool)
- func EnvHeader(rx *regexp.Regexp) http.Header
- func EnvMap(rx *regexp.Regexp) map[string]string
- func Exists(name string) (bool, error)
- func FileInfoModAge(fi os.FileInfo) time.Duration
- func FileInfosNames(fis []os.FileInfo) []string
- func FileInfosSplit(all []os.FileInfo, inclDotDirs bool) ([]os.FileInfo, []os.FileInfo)
- func FileModAge(filename string) (time.Duration, error)
- func FileModAgeLTE(filename string, s string) (bool, error)
- func FilenModAgeGTE(filename string, s string) (bool, error)
- func Filenames(name string, rx *regexp.Regexp, inclEmptyFiles, absPath bool) ([]string, error)
- func FilenamesFilterSizeGTZero(filepaths ...string) []string
- func FinfosToFilepaths(dir string, fis []os.FileInfo) []string
- func GetFileInfo(path string) (os.FileInfo, error)
- func GoPath(parts ...string) string
- func IsDir(name string) (bool, error)
- func IsFile(name string, sizeGtZero bool) (bool, error)
- func MustFileSize(filename string) int64
- func MustUserHomeDir(subdirs ...string) string
- func NewLine() string
- func ReadDirRxSubmatch(dir string, rx *regexp.Regexp, subMatchIdx uint, ...) (map[string][]os.DirEntry, error)
- func ReadDirRxSubmatchCaptureGreatest(dir string, rx *regexp.Regexp, subMatchIdx uint, ...) (string, error)
- func ReadDirRxSubmatchCaptures(dir string, rx *regexp.Regexp, subMatchIdx uint, ...) ([]string, error)
- func ReadDirRxSubmatchEntriesGreatest(dir string, rx *regexp.Regexp, subMatchIdx uint, ...) ([]os.DirEntry, error)
- func ReadDirSplit(dirname string, inclDotDirs bool) ([]os.FileInfo, []os.FileInfo, error)
- func ReadFileByLine(name string, lineFunc func(idx uint, line string) error) error
- func ReadFileJSON(file string, v any) error
- func ReadSubdirMax(dir string, rx *regexp.Regexp) (os.DirEntry, error)
- func ReadSubdirMin(dir string, rx *regexp.Regexp) (os.DirEntry, error)
- func SortDirEntriesModTime(files DirEntries)
- func SplitBest(path string) (dir, file string, err error)
- func SplitBetter(path string) (dir, file string)
- func VisitFiles(name string, visitFunc func(dir string, info fs.FileInfo) error) error
- func VisitPath(dir string, rx *regexp.Regexp, inclDirs, inclFiles, inclEmptyFiles bool, ...) error
- func WriteFileJSON(filepath string, data any, perm os.FileMode, prefix, indent string) error
- func WriteFileReader(filename string, r io.Reader) error
- type DirEntries
- func (entries DirEntries) Dirs() DirEntries
- func (entries DirEntries) Files() DirEntries
- func (entries DirEntries) Infos() ([]os.FileInfo, error)
- func (entries DirEntries) Len() int
- func (entries DirEntries) Less(i, j int) bool
- func (entries DirEntries) Names(dir string) []string
- func (entries DirEntries) Sort()
- func (entries DirEntries) Swap(i, j int)
- func (entries DirEntries) WriteFileNames(filename, dir string, perm os.FileMode) error
- type DirEntriesMore
- type DirEntryMore
- type EnvVar
- type FileInfoMore
- type FileType
- type FileWriter
Constants ¶
const ( ColDir = "dir" ColName = "name" ColPath = "path" ColSize = "size" )
const ( NewlinePOSIX = "\n" NewlineMSFT = "\r\n" NewlineAPPLClassic = "\r" )
Variables ¶
var ( ErrWriterNotInitialized = errors.New("bufio.Writer not initialized") ErrFileNotInitialized = errors.New("os.File not initialized") )
Functions ¶
func AbsFilepath ¶
AbsFilepath returns an absolute filepath, using the user's current / home directory if indicated in the filepath string.
func CreateFileWithLines ¶
CreateFileWithLines creates a file and writes lines to it. It will optionally add a `lineSuffix` (e.g. `"\n"`) and use `bufio`.
func DirFromPath ¶ added in v0.44.0
func DirRemoveAllChildren ¶ added in v0.44.0
func EmptyAll ¶
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 EnvMap ¶ added in v0.63.2
EnvMap returns a map[string]string of environment variables that match a regular expression.
func FileInfoModAge ¶ added in v0.44.0
FileInfoModAge returns the file last modification age as a time.Duration.
func FileInfosNames ¶ added in v0.44.0
func FileInfosSplit ¶ added in v0.44.0
func FileModAge ¶
FileModAge returns a time.Duration representing the age of the named file from FileInfo.ModTime().
func Filenames ¶ added in v0.41.5
Filenames returns a list of filenames for files only (no directories). If a directory is provided it will return a list of filenames in that directory. If a `Regexp` or `inclEmptyFiles` params are provided, those will be use to filter the output.
func FilenamesFilterSizeGTZero ¶ added in v0.44.0
func FinfosToFilepaths ¶
FinfosToFilepaths returns a slice of string from a directory and sli=ce of `os.FileInfo`.
func GetFileInfo ¶
GetFileInfo returns an os.FileInfo from a filepath.
func IsFile ¶
IsFile verifies a path exists and is a file. It will optionally check if a file is not empty. An os file not exists check can be done with os.IsNotExist(err) which acts on error from os.Stat().
func MustFileSize ¶ added in v0.47.0
MustFileSize returns value of `FileInfo.Size()` which is length in bytes for regular files; system-dependent for others. It returns `-1` if an error is encountered.
func MustUserHomeDir ¶
func NewLine ¶ added in v0.47.0
func NewLine() string
NewLine uses `os.PathSeparator` to determine the newline characters for the local system.
func ReadDirRxSubmatch ¶
func ReadDirRxSubmatch(dir string, rx *regexp.Regexp, subMatchIdx uint, inclDirs, inclFiles, inclEmptyFiles bool) (map[string][]os.DirEntry, error)
ReadDirRxSubmatch takes a directory, regular expression and boolean to indicate whether to include zero size files and returns the greatest of a single match in the regular expression.
func ReadDirRxSubmatchCaptureGreatest ¶
func ReadDirRxSubmatchCaptureGreatest(dir string, rx *regexp.Regexp, subMatchIdx uint, inclDirs, inclFiles, inclEmptyFiles bool) (string, error)
ReadDirRxSubmatchCaptureGreatest takes a directory, regular expression and returns the greatest of a single submatch in the regular expression.
func ReadDirRxSubmatchCaptures ¶
func ReadDirRxSubmatchCaptures(dir string, rx *regexp.Regexp, subMatchIdx uint, inclDirs, inclFiles, inclEmptyFiles bool) ([]string, error)
ReadDirRxSubmatchCaptures takes a directory, regular expression and returns the greatest of captures from the regular expression.
func ReadDirSplit ¶ added in v0.44.0
ReadDirSplit returnsa slides of `os.FileInfo` for directories and files. Note: this isn't as necessary any more since `os.ReadDir()` returns a slice of `os.DirEntry{}` which has a `IsDir()` func.
func ReadFileByLine ¶ added in v0.41.0
func ReadFileJSON ¶ added in v0.44.0
ReadFileJSON reads and unmarshals a file.
func SortDirEntriesModTime ¶ added in v0.37.18
func SortDirEntriesModTime(files DirEntries)
SortDirEntriesModTime sorts `DirEntries` by last modified time. It will panic if an entry cannot retrieve `FileInfo` information.
func SplitBetter ¶ added in v0.44.0
func VisitFiles ¶ added in v0.39.5
func VisitPath ¶ added in v0.37.18
func VisitPath(dir string, rx *regexp.Regexp, inclDirs, inclFiles, inclEmptyFiles bool, visitFunc func(dir string) error) error
VisitPath visit a directory and all subdirectories, executing the supplied `visitFunc` on each.
func WriteFileJSON ¶ added in v0.44.0
Types ¶
type DirEntries ¶
DirEntries provides utility functions for `[]os.DirEntry`. Use as `entries := osutil.DirEntries(slice)`.
func ReadDirMore ¶
func (DirEntries) Dirs ¶ added in v0.49.0
func (entries DirEntries) Dirs() DirEntries
func (DirEntries) Files ¶ added in v0.49.0
func (entries DirEntries) Files() DirEntries
func (DirEntries) Infos ¶
func (entries DirEntries) Infos() ([]os.FileInfo, error)
Infos returns a `[]os.FileInfo` slice.
func (DirEntries) Len ¶
func (entries DirEntries) Len() int
func (DirEntries) Less ¶
func (entries DirEntries) Less(i, j int) bool
func (DirEntries) Names ¶
func (entries DirEntries) Names(dir string) []string
Names returns a slice of entry names. It can optionally add the directory path and sort the values.
func (DirEntries) Swap ¶
func (entries DirEntries) Swap(i, j int)
func (DirEntries) WriteFileNames ¶ added in v0.33.0
func (entries DirEntries) WriteFileNames(filename, dir string, perm os.FileMode) error
WriteFileNames writes a text file with filenames, one per line.
type DirEntriesMore ¶
type DirEntriesMore []DirEntryMore
func ReadDirFiles ¶
func ReadDirFiles(dir string, inclDirs, inclFiles, recursive bool) (DirEntriesMore, error)
type DirEntryMore ¶
type FileInfoMore ¶
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).
type FileWriter ¶ added in v0.44.0
func NewFileWriter ¶ added in v0.44.0
func NewFileWriter(path string) (FileWriter, error)
func (*FileWriter) Close ¶ added in v0.44.0
func (fw *FileWriter) Close() error
func (*FileWriter) WriteBytes ¶ added in v0.46.0
func (fw *FileWriter) WriteBytes(b []byte) (int, error)
func (*FileWriter) WriteString ¶ added in v0.46.0
func (fw *FileWriter) WriteString(addLinefeed bool, s ...string) (int, error)
Source Files
Directories