| commit | a3a47864623d4902aafe350b3b68ba7fac907546 | [log] [tgz] |
|---|---|---|
| author | Hiromu OCHIAI <[email protected]> | Tue Aug 20 10:44:37 2024 |
| committer | Hiromu OCHIAI <[email protected]> | Tue Aug 20 10:44:37 2024 |
| tree | ea6214cc68a58d3ce96035745fcd43a7d8c65942 | |
| parent | 67be77ee0fe2a43866658e3f5feffe0a41dfb414 [diff] |
Use FileCopyFunc to let users choose the way of copying
copy copies directories recursively.
package main import ( "fmt" cp "github.com/otiai10/copy" ) func main() { err := cp.Copy("your/src", "your/dest") fmt.Println(err) // nil }
// Options specifies optional actions on copying. type Options struct { // OnSymlink can specify what to do on symlink OnSymlink func(src string) SymlinkAction // OnDirExists can specify what to do when there is a directory already existing in destination. OnDirExists func(src, dest string) DirExistsAction // OnError can let users decide how to handle errors (e.g., you can suppress specific error). OnError func(src, dest, string, err error) error // Skip can specify which files should be skipped Skip func(srcinfo os.FileInfo, src, dest string) (bool, error) // RenameDestination can rename destination. // If not set, nil, it does nothing. RenameDestination func(src, dest string) (string, error) // PermissionControl can control permission of // every entry. // When you want to add permission 0222, do like // // PermissionControl = AddPermission(0222) // // or if you even don't want to touch permission, // // PermissionControl = DoNothing // // By default, PermissionControl = PreservePermission PermissionControl PermissionControlFunc // Sync file after copy. // Useful in case when file must be on the disk // (in case crash happens, for example), // at the expense of some performance penalty Sync bool // Preserve the atime and the mtime of the entries // On linux we can preserve only up to 1 millisecond accuracy PreserveTimes bool // Preserve the uid and the gid of all entries. PreserveOwner bool // The byte size of the buffer to use for copying files. // If zero, the internal default buffer of 32KB is used. // See https://golang.org/pkg/io/#CopyBuffer for more information. CopyBufferSize uint // If you want to add some limitation on reading src file, // you can wrap the src and provide new reader, // such as `RateLimitReader` in the test case. WrapReader func(src io.Reader) io.Reader // If given, copy.Copy refers to this fs.FS instead of the OS filesystem. // e.g., You can use embed.FS to copy files from embedded filesystem. FS fs.FS // NumOfWorkers represents the number of workers used for // concurrent copying contents of directories. // If 0 or 1, it does not use goroutine for copying directories. // Please refer to https://pkg.go.dev/golang.org/x/sync/semaphore for more details. NumOfWorkers int64 // PreferConcurrent is a function to determine whether or not // to use goroutine for copying contents of directories. // If PreferConcurrent is nil, which is default, it does concurrent // copying for all directories. // If NumOfWorkers is 0 or 1, this function will be ignored. PreferConcurrent func(srcdir, destdir string) (bool, error) }
// For example... opt := Options{ Skip: func(info os.FileInfo, src, dest string) (bool, error) { return strings.HasSuffix(src, ".git"), nil }, } err := Copy("your/directory", "your/directory.copy", opt)
