fileutil

Documentation

Index

• func CopyFile(src, dst string) error
• func ExpandPath(p string) (string, error)
• func FileExists(filename string) bool
• func HasDir(dirPath string) (bool, error)
• func HomeDir() string
• func MkdirAll(dirPath string) error
• func ReadFileAsBytes(filename string) ([]byte, error)
• func WriteFile(file string, data []byte) error

Functions

func CopyFile

func CopyFile(src, dst string) error

CopyFile copy a file from source to destination path.

func ExpandPath

func ExpandPath(p string) (string, error)

ExpandPath given a string which may be a relative path. 1. replace tilde with users home dir 2. expands embedded environment variables 3. cleans the path, e.g. /a/b/../c -> /a/c Note, it has limitations, e.g. ~someuser/tmp will not be expanded

func FileExists

func FileExists(filename string) bool

FileExists returns true if a file is not a directory and exists at the specified path.

func HasDir

func HasDir(dirPath string) (bool, error)

HasDir checks if a directory indeed exists at the specified path.

func HomeDir

func HomeDir() string

HomeDir for a user.

func MkdirAll

func MkdirAll(dirPath string) error

MkdirAll takes in a path, expands it if necessary, and looks through the permissions of every directory along the path, ensuring we are not attempting to overwrite any existing permissions. Finally, creates the directory accordingly with standardized, Prysm project permissions. This is the static-analysis enforced method for creating a directory programmatically in Prysm.

func ReadFileAsBytes

func ReadFileAsBytes(filename string) ([]byte, error)

ReadFileAsBytes expands a file name's absolute path and reads it as bytes from disk.

func WriteFile

func WriteFile(file string, data []byte) error

WriteFile is the static-analysis enforced method for writing binary data to a file in Prysm, enforcing a single entrypoint with standardized permissions.