Package kotlin.io.path
Convenient extensions for working with file system using java.nio.file.Path.
Types
CopyActionContext
Context for the copyAction
function passed to Path.copyToRecursively.
interface CopyActionContext
CopyActionResult
The result of the copyAction
function passed to Path.copyToRecursively that specifies further actions when copying an entry.
enum class CopyActionResult
FileVisitorBuilder
The builder to provide implementation of the file visitor that fileVisitor builds.
sealed interface FileVisitorBuilder
OnErrorResult
The result of the onError
function passed to Path.copyToRecursively that specifies further actions when an exception occurs.
enum class OnErrorResult
PathWalkOption
An enumeration to provide walk options for Path.walk function. The options can be combined to form the walk order and behavior needed.
enum class PathWalkOption
Annotations
ExperimentalPathApi
This annotation marks the extensions and top-level functions for working with java.nio.file.Path considered experimental.
annotation class ExperimentalPathApi
Extensions for External Classes
Functions
createTempDirectory
Creates a new directory in the default temp directory, using the given prefix to generate its name.
fun createTempDirectory(
prefix: String? = null,
vararg attributes: FileAttribute<*>
): Path
Creates a new directory in the specified directory, using the given prefix to generate its name.
fun createTempDirectory(
directory: Path?,
prefix: String? = null,
vararg attributes: FileAttribute<*>
): Path
createTempFile
Creates an empty file in the default temp directory, using the given prefix and suffix to generate its name.
fun createTempFile(
prefix: String? = null,
suffix: String? = null,
vararg attributes: FileAttribute<*>
): Path
fileVisitor
Builds a FileVisitor whose implementation is defined in builderAction.
fun fileVisitor(
builderAction: FileVisitorBuilder.() -> Unit
): FileVisitor<Path>