Update README
1 file changed
tree: b61c9cf3260ce7e7b112ba16c17b8a4fe4aaa302
  1. .github/
  2. test/
  3. .gitignore
  4. all_test.go
  5. copy.go
  6. copy_namedpipes.go
  7. copy_namedpipes_x.go
  8. example_test.go
  9. fileinfo.go
  10. go.mod
  11. go.sum
  12. LICENSE
  13. options.go
  14. patherror_go1.15_test.go
  15. patherror_go1.16_test.go
  16. preserve_owner.go
  17. preserve_owner_windows.go
  18. preserve_times.go
  19. README.md
  20. stat_times.go
  21. stat_times_darwin.go
  22. stat_times_freebsd.go
  23. stat_times_windows.go
  24. stat_times_x.go
  25. test_setup.go
  26. test_setup_x.go
README.md

copy

Go Reference Actions Status codecov License: MIT FOSSA Status CodeQL Go Report Card GitHub tag (latest SemVer) Docker Test Vagrant Test

copy copies directories recursively.

Example Usage

err := Copy("your/directory", "your/directory.copy")

Advanced Usage

// 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

	// Skip can specify which files should be skipped
	Skip func(src string) (bool, error)

	// AddPermission to every entry,
	// NO MORE THAN 0777
	AddPermission os.FileMode

	// 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
}
// For example...
opt := Options{
	Skip: func(src string) (bool, error) {
		return strings.HasSuffix(src, ".git"), nil
	},
}
err := Copy("your/directory", "your/directory.copy", opt)

Issues

License

FOSSA Status