fileutils

Documentation

Index

• func CleanDirectory(dirPath string) error
• func CompareDirectories(dir1, dir2 string) (bool, error)
• func CompareDirectoriesHasher(dir1, dir2 string, h hash.Hash) (bool, error)
• func ExistsAndIsDirectory(path string) (exists, isDir bool, err error)
• func ReadOrPanic(p string) []byte
• func ReplaceDirectory(currentPath, targetPath string) error
• func ReplaceFile(currentPath, targetPath string) error
• func SafeReadFile(filePath string, perm os.FileMode) ([]byte, error)
• func SafeReadYAML(filePath string, targetPointer any, perm os.FileMode) (yamlAvailable bool, err error)

Functions

func CleanDirectory

func CleanDirectory(dirPath string) error

CleanDirectory removes all files and subdirectories within dirPath, leaving the directory itself intact.

func CompareDirectories

func CompareDirectories(dir1, dir2 string) (bool, error)

CompareDirectories checks if two directories have the same structure and content. Walks both folders and ensures the contents are identical (compares file hashes).

func CompareDirectoriesHasher

func CompareDirectoriesHasher(dir1, dir2 string, h hash.Hash) (bool, error)

CompareDirectoriesHasher checks if two directories have the same structure and content. Walks both folders and ensures the contents are identical (compares file hashes).

func ExistsAndIsDirectory

func ExistsAndIsDirectory(path string) (exists, isDir bool, err error)

func ReadOrPanic

func ReadOrPanic(p string) []byte

ReadOrPanic reads the entire file at the provided path or panics if it is not possible.

func ReplaceDirectory

func ReplaceDirectory(currentPath, targetPath string) error

ReplaceDirectory atomically replaces the directory at targetPath with the directory at currentPath. It removes any existing directory at currentPath and uses a unique lock file based on targetPath.

func ReplaceFile

func ReplaceFile(currentPath, targetPath string) error

ReplaceFile atomically replaces the file at targetPath with the file at currentPath, using a unique lock file based on targetPath.

func SafeReadFile

func SafeReadFile(filePath string, perm os.FileMode) ([]byte, error)

SafeReadFile reads the file at the provided path into a byte slice.

func SafeReadYAML

func SafeReadYAML(filePath string, targetPointer any, perm os.FileMode) (yamlAvailable bool, err error)

SafeReadYAML reads the YAML file at the path into the targetPointer. Returns true if the file exists or an error if an error occurred.