copyToRecursively

Recursively copies this directory and its content to the specified destination target path. Note that if this function throws, partial copying may have taken place.

Unlike File.copyRecursively, if some directories on the way to the target are missing, then they won't be created automatically. You can use the following approach to ensure that required intermediate directories are created:

sourcePath.copyToRecursively(
    destinationPath.apply { parent?.createDirectories() },
    followLinks = false
)

If the entry located by this path is a directory, this function recursively copies the directory itself and its content. Otherwise, this function copies only the entry.

If an exception occurs attempting to read, open or copy any entry under the source subtree, further actions will depend on the result of the onError invoked with the source and destination paths, that caused the error, and the exception itself as arguments. If onError throws, this function ends immediately with the exception. By default onError rethrows the exception. See OnErrorResult for available options.

This function performs "directory merge" operation. If an entry in the source subtree is a directory and the corresponding entry in the target subtree already exists and is also a directory, it does nothing. Otherwise, overwrite determines whether to overwrite existing destination entries. Attributes of a source entry, such as creation/modification date, are not copied. followLinks determines whether to copy a symbolic link itself or its target. Symbolic links in the target subtree are not followed.

To provide a custom logic for copying use the overload that takes a copyAction lambda.

Parameters

Throws

Recursively copies this directory and its content to the specified destination target path. Note that if this function throws, partial copying may have taken place.

Unlike File.copyRecursively, if some directories on the way to the target are missing, then they won't be created automatically. You can use the following approach to ensure that required intermediate directories are created:

sourcePath.copyToRecursively(
    destinationPath.apply { parent?.createDirectories() },
    followLinks = false
)

If the entry located by this path is a directory, this function recursively copies the directory itself and its content. Otherwise, this function copies only the entry.

If an exception occurs attempting to read, open or copy any entry under the source subtree, further actions will depend on the result of the onError invoked with the source and destination paths, that caused the error, and the exception itself as arguments. If onError throws, this function ends immediately with the exception. By default onError rethrows the exception. See OnErrorResult for available options.

Copy operation is performed using copyAction. By default copyAction performs "directory merge" operation. If an entry in the source subtree is a directory and the corresponding entry in the target subtree already exists and is also a directory, it does nothing. Otherwise, the entry is copied using sourcePath.copyTo(destinationPath, *followLinksOption), which doesn't copy attributes of the source entry and throws if the destination entry already exists. followLinks determines whether to copy a symbolic link itself or its target. Symbolic links in the target subtree are not followed.

If a custom implementation of copyAction is provided, consider making it consistent with followLinks value. See CopyActionResult for available options.

If copyAction throws an exception, it is passed to onError for handling.

Parameters

Throws