osutil

Documentation

Index

• Constants
• Variables
• func CopyDir(srcDir, dstDir string) error
• func CopyFile(ctx context.Context, src, out string) error
• func CopyReaderWithMode(ctx context.Context, src io.Reader, mode fs.FileMode, out string) error
• func EnsureDir(path string, perm fs.FileMode) error
• func HashFile(h hash.Hash, path string) error
• func HashFileWithName(h hash.Hash, root, path string) error
• func HashFiles(h hash.Hash, root string) error
• func ModeOf(path string) (fs.FileMode, error)
• type Path
  • func (p Path) CheckIsDir() error
  • func (p Path) CheckIsDirOrEmpty() error
  • func (p Path) CheckIsFile() error
  • func (p Path) CheckIsFileOrEmpty() error
  • func (p Path) Dir() Path
  • func (p Path) Join(elem ...string) Path
  • func (p *Path) RelTo(base Path) error
  • func (p Path) String() string

Constants

const ModeUserRW = 0600 // rw-------

const ModeUserRWX = 0700 // rwx------

const ModeUserRWXGroupRX = 0750 // rwxr-x---

Variables

var ErrInvalidInput = errors.New("invalid input")

var ErrMissingInput = errors.New("missing input")

var ErrUnsupportedFileType = errors.New("unsupported file type")

ErrUnsupportedFileType is returned when attempting to copy a file type that's not supported.

Functions

func CopyDir

func CopyDir(srcDir, dstDir string) error

CopyDir recursively copies a directory from 'srcDir' to 'dstDir', preserving soft links. All regular files will be hard copied. Note that file attributes are not preserved, so this should only be used when the folder contents are required in the original structure. This implementation is based on [1].

[1] https://github.com/moby/moby/blob/master/daemon/graphdriver/copy/copy.go

func CopyFile

func CopyFile(ctx context.Context, src, out string) error

CopyFile is a utility function for copying an 'io.Reader' to a new file created with the specified 'os.FileMode'.

func CopyReaderWithMode

func CopyReaderWithMode(ctx context.Context, src io.Reader, mode fs.FileMode, out string) error

CopyReaderWithMode is a utility function for copying an 'io.Reader' to a new file created with the specified 'os.FileMode'.

func EnsureDir

func EnsureDir(path string, perm fs.FileMode) error

EnsureDir verifies that the specified path exists, is a directory, and has the specified permission bits set.

func HashFile

func HashFile(h hash.Hash, path string) error

func HashFileWithName

func HashFileWithName(h hash.Hash, root, path string) error

func HashFiles

func HashFiles(h hash.Hash, root string) error

HashFiles updates the provided 'hash.Hash' with the file structure contents rooted at 'root'.

func ModeOf

func ModeOf(path string) (fs.FileMode, error)

ModeOf returns the file mode of the specified file.

Types

type Path

type Path string

Path is a string type that's expected to be a path.

func (Path) CheckIsDir

func (p Path) CheckIsDir() error

CheckIsDir verifies that the underlying path is a valid directory.

func (Path) CheckIsDirOrEmpty

func (p Path) CheckIsDirOrEmpty() error

CheckIsDirOrEmpty verifies that the underlying path is either empty or a valid directory.

func (Path) CheckIsFile

func (p Path) CheckIsFile() error

CheckIsFile verifies that the underlying path is a valid file.

func (Path) CheckIsFileOrEmpty

func (p Path) CheckIsFileOrEmpty() error

CheckIsFileOrEmpty verifies that the underlying path is either empty or a valid file.

func (Path) Dir

func (p Path) Dir() Path

Dir creates a new 'Path' pointing to the directory of this 'Path'.

func (Path) Join

func (p Path) Join(elem ...string) Path

Join creates a new 'Path' with the provided elements appended.

func (*Path) RelTo

func (p *Path) RelTo(base Path) error

RelTo converts the underlying path into a cleaned, absolute path. If the path is relative it's first resolved against the provided base path (or current working directory if 'base' is empty).

func (Path) String

func (p Path) String() string