Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/otiai10/copy
Go copy directory recursively
https://github.com/otiai10/copy
copy directories directory files folder folders go golang recursive
Last synced: 2 days ago
JSON representation
Go copy directory recursively
- Host: GitHub
- URL: https://github.com/otiai10/copy
- Owner: otiai10
- License: mit
- Created: 2017-09-01T03:18:56.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-04T21:19:52.000Z (2 months ago)
- Last Synced: 2024-10-29T14:04:46.708Z (about 1 month ago)
- Topics: copy, directories, directory, files, folder, folders, go, golang, recursive
- Language: Go
- Homepage: https://pkg.go.dev/github.com/otiai10/copy
- Size: 222 KB
- Stars: 721
- Watchers: 11
- Forks: 115
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - copy - Copy directory recursively. (File Handling / Search and Analytic Databases)
- go-awesome - copy - copy folder (Open source library / Files/Storage)
- awesome-go-extra - copy - 09-01T03:18:56Z|2022-08-23T08:10:38Z| (File Handling / Advanced Console UIs)
README
# copy
[](https://pkg.go.dev/github.com/otiai10/copy)
[](https://github.com/otiai10/copy/actions)
[](https://codecov.io/gh/otiai10/copy)
[](https://github.com/otiai10/copy/blob/main/LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fotiai10%2Fcopy?ref=badge_shield)
[](https://github.com/otiai10/copy/actions/workflows/codeql-analysis.yml)
[](https://goreportcard.com/report/github.com/otiai10/copy)
[](https://pkg.go.dev/github.com/otiai10/copy)
[](https://github.com/otiai10/copy/actions/workflows/docker-test.yml)
[](https://github.com/otiai10/copy/actions/workflows/vagrant-test.yml)
[](https://github.com/otiai10/copy/actions/workflows/gopherjs.yml)
[](https://github.com/otiai10/copy/actions/workflows/wasm.yml)
`copy` copies directories recursively.
# Example Usage
```go
package main
import (
"fmt"
cp "github.com/otiai10/copy"
)
func main() {
err := cp.Copy("your/src", "your/dest")
fmt.Println(err) // nil
}
```
# Advanced Usage
```go
// 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)
}
```
```go
// 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)
```
# Issues
- https://github.com/otiai10/copy/issues
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fotiai10%2Fcopy?ref=badge_large)