shutil

README

go-shutil

golang shutil port from python

See also: https://docs.python.org/3.5/library/shutil.html

Documentation

Index

• func Copy2(src, dst string, options *CopyOptions) (string, error)
• func CopyFile(src, dst string, options *CopyOptions) (string, error)
• func CopyStat(src, dst string, options *CopyOptions) error
• func CopyTree(src, dst string, options *CopyTreeOptions) (string, error)
• func RmTree(path string, options *RmTreeOptions) error
• type CopyNotCompleteError
  • func (e CopyNotCompleteError) Error() string
• type CopyOptions
• type CopyTreeOptions
• type RmTreeOptions
• type SameFileError
  • func (e SameFileError) Error() string
• type SpecialFileError
  • func (e SpecialFileError) Error() string

Functions

func Copy2

func Copy2(src, dst string, options *CopyOptions) (string, error)

Copy data and all stat info ("cp -p src dst"). Return the file's destination."

The destination may be a directory.

If follow_symlinks is false, symlinks won't be followed. This resembles GNU's "cp -P src dst".

func CopyFile

func CopyFile(src, dst string, options *CopyOptions) (string, error)

Copy data from src to dst.

If follow_symlinks is not set and src is a symbolic link, a new symlink will be created instead of copying the file it points to.

func CopyStat

func CopyStat(src, dst string, options *CopyOptions) error

Copy all stat info (mode bits, atime, mtime, flags) from src to dst.

If the optional flag `follow_symlinks` is not set, symlinks aren't followed if and only if both `src` and `dst` are symlinks.

func CopyTree

func CopyTree(src, dst string, options *CopyTreeOptions) (string, error)

Recursively copy a directory tree.

The destination directory must not already exist. If exception(s) occur, an Error is raised with a list of reasons.

If the optional symlinks flag is true, symbolic links in the source tree result in symbolic links in the destination tree; if it is false, the contents of the files pointed to by symbolic links are copied. If the file pointed by the symlink doesn't exist, an exception will be added in the list of errors raised in an Error exception at the end of the copy process.

You can set the optional ignore_dangling_symlinks flag to true if you want to silence this exception. Notice that this has no effect on platforms that don't support os.symlink.

The optional ignore argument is a callable. If given, it is called with the `src` parameter, which is the directory being visited by copytree(), and `names` which is the list of `src` contents, as returned by os.listdir():

callable(src, names) -> ignored_names

Since copytree() is called recursively, the callable will be called once for each directory that is copied. It returns a list of names relative to the `src` directory that should not be copied.

The optional copy_function argument is a callable that will be used to copy each file. It will be called with the source path and the destination path as arguments. By default, copy2() is used, but any function that supports the same signature (like copy()) can be used.

func RmTree

func RmTree(path string, options *RmTreeOptions) error

Recursively delete a directory tree.

If ignore_errors is set, errors are ignored; otherwise, if onerror is set, it is called to handle the error with arguments (func, path, exc_info) where func is platform and implementation dependent; path is the argument to that function that caused it to fail; and exc_info is a tuple returned by sys.exc_info(). If ignore_errors is false and onerror is None, an exception is raised.

Types

type CopyNotCompleteError

type CopyNotCompleteError struct {
	Src string
	Dst string
}

func (CopyNotCompleteError) Error

func (e CopyNotCompleteError) Error() string

type CopyOptions

type CopyOptions struct {
	FollowSymlinks bool
}

type CopyTreeOptions

type CopyTreeOptions struct {
	Symlinks               bool
	Ignore                 func(string, []os.FileInfo) []string
	CopyFunction           func(string, string, *CopyOptions) (string, error)
	IgnoreDanglingSymlinks bool
}

type RmTreeOptions

type RmTreeOptions struct {
	IgnoreErrors bool
	OnError      func(fn func(string), path string, exec_info interface{})
}

type SameFileError

type SameFileError struct {
	Src string
	Dst string
}

func (SameFileError) Error

func (e SameFileError) Error() string

type SpecialFileError

type SpecialFileError struct {
	File string
}

func (SpecialFileError) Error

func (e SpecialFileError) Error() string