file

Documentation

Index

• func CopyDir(src, dst string) error
• func CopyFile(src, dst string) error
• func DirFiles(dir string) ([]string, error)
• func DirsEqual(src, dst string) bool
• func Exists(filename string, objType ObjType) (bool, error)
• func ExpandPath(p string) (string, error)
• func HandleBackupDir(dirPath string, permissionOverride bool) error
• func HasDir(dirPath string) (bool, error)
• func HasReadWritePermissions(itemPath string) (bool, error)
• func HashDir(dir string) (string, error)
• func HashFile(filePath string) ([]byte, error)
• func HomeDir() string
• func MkdirAll(dirPath string) error
• func ReadFileAsBytes(filename string) ([]byte, error)
• func RecursiveDirFind(dirname, dir string) (bool, string, error)
• func RecursiveFileFind(filename, dir string) (bool, string, error)
• func WriteFile(file string, data []byte) error
• type ObjType

Functions

func CopyDir

func CopyDir(src, dst string) error

CopyDir copies contents of one directory into another, recursively.

func CopyFile

func CopyFile(src, dst string) error

CopyFile copy a file from source to destination path.

func DirFiles

func DirFiles(dir string) ([]string, error)

DirFiles returns list of files found within a given directory and its sub-directories. Directory prefix will not be included as a part of returned file string i.e. for a file located in "dir/foo/bar" only "foo/bar" part will be returned.

func DirsEqual

func DirsEqual(src, dst string) bool

DirsEqual checks whether two directories have the same content.

func Exists

func Exists(filename string, objType ObjType) (bool, error)

Exists returns true if a file is not a directory and exists at the specified 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 HandleBackupDir

func HandleBackupDir(dirPath string, permissionOverride bool) error

HandleBackupDir takes an input directory path and either alters its permissions to be usable if it already exists, creates it if not

func HasDir

func HasDir(dirPath string) (bool, error)

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

func HasReadWritePermissions

func HasReadWritePermissions(itemPath string) (bool, error)

HasReadWritePermissions checks if file at a path has proper 0600 permissions set.

func HashDir

func HashDir(dir string) (string, error)

HashDir calculates and returns hash of directory: each file's hash is calculated and saved along with the file name into the list, after which list is hashed to produce the final signature. Implementation is based on https://github.com/golang/mod/blob/release-branch.go1.15/sumdb/dirhash/hash.go

func HashFile

func HashFile(filePath string) ([]byte, error)

HashFile calculates and returns the hash of a file.

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 creates the directory accordingly with standardized, Prysm project permissions. If a directory already exists as this path, then the method returns without making any changes. 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 RecursiveDirFind

func RecursiveDirFind(dirname, dir string) (bool, string, error)

RecursiveDirFind searches for directory in a directory and its subdirectories.

func RecursiveFileFind

func RecursiveFileFind(filename, dir string) (bool, string, error)

RecursiveFileFind searches for file in a directory and its subdirectories.

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.

Types

type ObjType

type ObjType int

const (
	Regular ObjType = iota
	Directory
)