fileutils

Documentation

Index

• func ExistsAndIsDirectory(path string) (exists, isDir bool, err error)
• func ReadOrPanic(p string) []byte
• func SafeReadFile(filePath string, perm os.FileMode) ([]byte, error)
• func SafeReadJSON(filePath string, targetPointer any, perm os.FileMode) (jsonAvailable bool, err error)
• func SafeReadYAML(filePath string, targetPointer any, perm os.FileMode) (yamlAvailable bool, err error)
• func SafeWriteJson[T any](filePath string, targetPointer *T) error

Functions

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 SafeReadFile

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

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

func SafeReadJSON

func SafeReadJSON(filePath string, targetPointer any, perm os.FileMode) (jsonAvailable bool, err error)

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

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.

func SafeWriteJson

func SafeWriteJson[T any](filePath string, targetPointer *T) error

SafeWriteJson writes the provided object to a JSON file at the provided path. The function makes sure any changes are flushed to the disk before returning.