Объявления уровня пакета

kotlin-stdlib/kotlin.io.path

Удобные расширения для работы с файловой системой с использованием java.nio.file.Path.

Типы

Начиная с Kotlin: 1.8


@ExperimentalPathApi
interface CopyActionContext

Контекст для функции copyAction, передаваемой в Path.copyToRecursively.

CopyActionResult

Начиная с Kotlin: 1.8


@ExperimentalPathApi
enum CopyActionResult : Enum<CopyActionResult>

Результат функции copyAction, передаваемой в Path.copyToRecursively, который задает дальнейшие действия при копировании записи.

ExperimentalPathApi

Начиная с Kotlin: 1.4



@RequiresOptIn(level = RequiresOptIn.Level.ERROR)


@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalPathApi

Эта аннотация помечает расширения и функции верхнего уровня для работы с java.nio.file.Path, которые считаются экспериментальными.

FileVisitorBuilder

Начиная с Kotlin: 2.1

sealed interface FileVisitorBuilder

Построитель для предоставления реализации FileVisitor, которую создает функция fileVisitor.

OnErrorResult

Начиная с Kotlin: 1.8


@ExperimentalPathApi
enum OnErrorResult : Enum<OnErrorResult>

Результат функции onError, передаваемой в Path.copyToRecursively, который задает дальнейшие действия при возникновении исключения.

PathWalkOption

Начиная с Kotlin: 2.1

enum PathWalkOption : Enum<PathWalkOption>

Перечисление, предоставляющее параметры обхода для функции Path.walk. Параметры можно комбинировать, чтобы задать нужный порядок и поведение обхода.

Свойства

extension

Начиная с Kotlin: 1.5

val Path.extension: String

Возвращает расширение этого пути (без точки) или пустую строку, если расширения нет.

invariantSeparatorsPath

Начиная с Kotlin: 1.4


@ExperimentalPathApi
val Path.invariantSeparatorsPath: String

invariantSeparatorsPathString

Начиная с Kotlin: 1.5

val Path.invariantSeparatorsPathString: String

Возвращает строковое представление этого пути, используя инвариантный разделитель «/» для разделения имен в пути.

name

Начиная с Kotlin: 1.5

val Path.name: String

Возвращает в виде строки имя файла или каталога, обозначенного этим путем, или пустую строку, если путь не содержит элементов.

nameWithoutExtension

Начиная с Kotlin: 1.5

val Path.nameWithoutExtension: String

Возвращает имя этого файла или каталога без расширения либо пустую строку, если путь не содержит элементов.

pathString

Начиная с Kotlin: 1.5

val Path.pathString: String

Возвращает строковое представление этого пути.

Функции

absolute

В Kotlin начиная с: 1.5

inline fun Path.absolute(): Path

Преобразует этот путь, который может быть относительным, в абсолютный путь.

absolutePathString

В Kotlin начиная с: 1.5

inline fun Path.absolutePathString(): String

Преобразует этот путь, который может быть относительным, в абсолютный путь и возвращает его строковое представление.

appendBytes

В Kotlin начиная с: 1.5

inline fun Path.appendBytes(array: ByteArray)

Добавляет массив байтов в содержимое этого файла.

appendLines

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.appendLines(lines: Iterable<CharSequence>, charset: Charset = Charsets.UTF_8): Path

Добавляет указанную коллекцию строк символов в виде строк в файл, завершая каждую из них разделителем строк, используемым на данной платформе.


@IgnorableReturnValue
inline fun Path.appendLines(lines: Sequence<CharSequence>, charset: Charset = Charsets.UTF_8): Path

Добавляет указанную последовательность строк символов в виде строк в файл, завершая каждую из них разделителем строк, используемым на данной платформе.

appendText

В Kotlin начиная с: 1.5

fun Path.appendText(text: CharSequence, charset: Charset = Charsets.UTF_8)

Добавляет текст в содержимое этого файла, используя UTF-8 или указанную кодировку.

bufferedReader

В Kotlin начиная с: 1.5

inline fun Path.bufferedReader(charset: Charset = Charsets.UTF_8, bufferSize: Int = DEFAULT_BUFFER_SIZE, vararg options: OpenOption): BufferedReader

Возвращает новый BufferedReader для чтения содержимого этого файла.

bufferedWriter

В Kotlin начиная с: 1.5

inline fun Path.bufferedWriter(charset: Charset = Charsets.UTF_8, bufferSize: Int = DEFAULT_BUFFER_SIZE, vararg options: OpenOption): BufferedWriter

Возвращает новый BufferedWriter для записи содержимого этого файла.

copyTo

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.copyTo(target: Path, overwrite: Boolean = false): Path


@IgnorableReturnValue
inline fun Path.copyTo(target: Path, vararg options: CopyOption): Path

Копирует файл или каталог, указанный этим путем, по заданному пути назначения.

copyToRecursively

В Kotlin начиная с: 1.8



@ExperimentalPathApi


@IgnorableReturnValue

fun Path.copyToRecursively(target: Path, onError: (source: Path, target: Path, Exception) -> OnErrorResult = { _, _, exception -> throw exception }, followLinks: Boolean, overwrite: Boolean): Path



@ExperimentalPathApi


@IgnorableReturnValue

fun Path.copyToRecursively(target: Path, onError: (source: Path, target: Path, Exception) -> OnErrorResult = { _, _, exception -> throw exception }, followLinks: Boolean, copyAction: CopyActionContext.(source: Path, target: Path) -> CopyActionResult = { src, dst -> src.copyToIgnoringExistingDirectory(dst, followLinks) }): Path

Рекурсивно копирует этот каталог и его содержимое по указанному пути назначения. Обратите внимание: если эта функция выбрасывает исключение, копирование могло выполниться частично.

createDirectories

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.createDirectories(vararg attributes: FileAttribute<*>): Path

Создает каталог, предварительно создавая все отсутствующие родительские каталоги, чтобы обеспечить их существование.

createDirectory

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.createDirectory(vararg attributes: FileAttribute<*>): Path

Создает новый каталог или выбрасывает исключение, если по этому пути уже находится файл или каталог.

createFile

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.createFile(vararg attributes: FileAttribute<*>): Path

Создает новый пустой файл, указанный этим путем; если файл уже существует, операция завершается ошибкой.

createLinkPointingTo

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.createLinkPointingTo(target: Path): Path

Создает по этому пути новую ссылку (запись каталога) на существующий файл назначения.

createParentDirectories

В Kotlin начиная с: 1.9


@IgnorableReturnValue
fun Path.createParentDirectories(vararg attributes: FileAttribute<*>): Path

Обеспечивает существование всех родительских каталогов этого пути, создавая их при необходимости.

createSymbolicLinkPointingTo

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.createSymbolicLinkPointingTo(target: Path, vararg attributes: FileAttribute<*>): Path

Создает по этому пути новую символическую ссылку на указанное назначение.

createTempDirectory

В Kotlin начиная с: 1.5

inline fun createTempDirectory(prefix: String? = null, vararg attributes: FileAttribute<*>): Path

Создает новый каталог в каталоге временных файлов по умолчанию, используя заданный префикс для формирования его имени.

fun createTempDirectory(directory: Path?, prefix: String? = null, vararg attributes: FileAttribute<*>): Path

Создает новый каталог в указанном каталоге, используя заданный префикс для формирования его имени.

createTempFile

В Kotlin начиная с: 1.5

inline fun createTempFile(prefix: String? = null, suffix: String? = null, vararg attributes: FileAttribute<*>): Path

Создает пустой файл в каталоге временных файлов по умолчанию, используя заданные префикс и суффикс для формирования его имени.

fun createTempFile(directory: Path?, prefix: String? = null, suffix: String? = null, vararg attributes: FileAttribute<*>): Path

Создает пустой файл в указанном каталоге, используя заданные префикс и суффикс для формирования его имени.

deleteExisting

В Kotlin начиная с: 1.5

inline fun Path.deleteExisting()

Удаляет существующий файл или пустой каталог, указанный этим путем.

deleteIfExists

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.deleteIfExists(): Boolean

Удаляет указанный этим путем файл или пустой каталог, если он существует.

deleteRecursively

В Kotlin начиная с: 1.8


@ExperimentalPathApi
fun Path.deleteRecursively()

Рекурсивно удаляет этот каталог и его содержимое. Обратите внимание: если эта функция выбрасывает исключение, удаление могло выполниться частично.

div

В Kotlin начиная с: 1.5

inline operator fun Path.div(other: Path): Path

Разрешает указанный путь other относительно этого пути.

inline operator fun Path.div(other: String): Path

Разрешает указанную строку пути other относительно этого пути.

exists

В Kotlin начиная с: 1.5

inline fun Path.exists(vararg options: LinkOption): Boolean

Проверяет, существует ли файл, указанный этим путем.

fileAttributesView

В Kotlin начиная с: 1.5

inline fun <V : FileAttributeView> Path.fileAttributesView(vararg options: LinkOption): V

Возвращает представление атрибутов файла заданного типа V или выбрасывает UnsupportedOperationException, если запрошенный тип представления атрибутов недоступен..

fileAttributesViewOrNull

В Kotlin начиная с: 1.5

inline fun <V : FileAttributeView> Path.fileAttributesViewOrNull(vararg options: LinkOption): V?

Возвращает представление атрибутов файла заданного типа V или null, если запрошенный тип представления атрибутов недоступен.

fileSize

В Kotlin начиная с: 1.5

inline fun Path.fileSize(): Long

Возвращает размер обычного файла в виде значения Long, выраженного в байтах, или выбрасывает исключение, если файл не существует.

fileStore

В Kotlin начиная с: 1.5

inline fun Path.fileStore(): FileStore

Возвращает FileStore, представляющий файловое хранилище, в котором находится файл.

fileVisitor

В Kotlin начиная с: 2.1

fun fileVisitor(builderAction: FileVisitorBuilder.() -> Unit): FileVisitor<Path>

Создает FileVisitor, реализация которого задается в builderAction.

forEachDirectoryEntry

В Kotlin начиная с: 1.5

inline fun Path.forEachDirectoryEntry(glob: String = "*", action: (Path) -> Unit)

Выполняет указанное действие для каждой записи в этом каталоге; при необходимости записи фильтруются по соответствию указанному шаблону glob.

forEachLine

В Kotlin начиная с: 1.5

inline fun Path.forEachLine(charset: Charset = Charsets.UTF_8, action: (line: String) -> Unit)

Считывает этот файл построчно с использованием указанной кодировки и вызывает action для каждой строки. По умолчанию используется кодировка UTF-8.

getAttribute

В Kotlin начиная с: 1.5

inline fun Path.getAttribute(attribute: String, vararg options: LinkOption): Any?

Считывает значение атрибута файла.

getLastModifiedTime

В Kotlin начиная с: 1.5

inline fun Path.getLastModifiedTime(vararg options: LinkOption): FileTime

Возвращает время последнего изменения файла, указанного этим путем.

getOwner

В Kotlin начиная с: 1.5

inline fun Path.getOwner(vararg options: LinkOption): UserPrincipal?

Возвращает владельца файла.

getPosixFilePermissions

В Kotlin начиная с: 1.5

inline fun Path.getPosixFilePermissions(vararg options: LinkOption): Set<PosixFilePermission>

Возвращает разрешения POSIX для файла, указанного этим путем.

inputStream

В Kotlin начиная с: 1.5

inline fun Path.inputStream(vararg options: OpenOption): InputStream

Создает новый InputStream для этого файла и возвращает его в качестве результата.

isDirectory

В Kotlin начиная с: 1.5

inline fun Path.isDirectory(vararg options: LinkOption): Boolean

Проверяет, является ли файл, указанный этим путем, каталогом.

isExecutable

В Kotlin начиная с: 1.5

inline fun Path.isExecutable(): Boolean

Проверяет, существует ли файл, указанный этим путем, и является ли он исполняемым.

isHidden

В Kotlin начиная с: 1.5

inline fun Path.isHidden(): Boolean

Проверяет, считается ли файл, указанный этим путем, скрытым.

isReadable

В Kotlin начиная с: 1.5

inline fun Path.isReadable(): Boolean

Проверяет, существует ли файл, указанный этим путем, и доступен ли он для чтения.

isRegularFile

В Kotlin начиная с: 1.5

inline fun Path.isRegularFile(vararg options: LinkOption): Boolean

Проверяет, является ли файл, указанный этим путем, обычным файлом.

isSameFileAs

В Kotlin начиная с: 1.5

inline fun Path.isSameFileAs(other: Path): Boolean

Проверяет, указывает ли этот путь на тот же файл или каталог, что и other.

isSymbolicLink

В Kotlin начиная с: 1.5

inline fun Path.isSymbolicLink(): Boolean

Проверяет, существует ли файл, указанный этим путем, и является ли он символической ссылкой.

isWritable

В Kotlin начиная с: 1.5

inline fun Path.isWritable(): Boolean

Проверяет, существует ли файл, указанный этим путем, и доступен ли он для записи.

listDirectoryEntries

В Kotlin начиная с: 1.5

fun Path.listDirectoryEntries(glob: String = "*"): List<Path>

Возвращает список записей в этом каталоге; при необходимости записи фильтруются по соответствию указанному шаблону glob.

moveTo

В Kotlin начиная с: 1.5


@IgnorableReturnValue
inline fun Path.moveTo(target: Path, overwrite: Boolean = false): Path


@IgnorableReturnValue
inline fun Path.moveTo(target: Path, vararg options: CopyOption): Path

Перемещает файл, указанный этим путем, или переименовывает его, перемещая по пути назначения.

notExists

В Kotlin начиная с: 1.5

inline fun Path.notExists(vararg options: LinkOption): Boolean

Проверяет, что файл, указанный этим путем, не существует.

outputStream

В Kotlin начиная с: 1.5

inline fun Path.outputStream(vararg options: OpenOption): OutputStream

Создает новый OutputStream для этого файла и возвращает его в качестве результата.

Path

В Kotlin начиная с: 1.5

inline fun Path(path: String): Path

Преобразует указанную строку пути в объект Path файловой системы по умолчанию.

inline fun Path(base: String, vararg subpaths: String): Path

Преобразует последовательность имен, заданную строкой базового пути и несколькими дополнительными именами подпутей, в объект Path файловой системы по умолчанию.

readAttributes

В Kotlin начиная с: 1.5

inline fun <A : BasicFileAttributes> Path.readAttributes(vararg options: LinkOption): A

Считывает за одну операцию атрибуты файла указанного типа A.

inline fun Path.readAttributes(attributes: String, vararg options: LinkOption): Map<String, Any?>

Считывает за одну операцию указанный список атрибутов файла.

readBytes

В Kotlin начиная с: 1.5

inline fun Path.readBytes(): ByteArray

Возвращает все содержимое этого файла в виде массива байтов.

reader

В Kotlin начиная с: 1.5

inline fun Path.reader(charset: Charset = Charsets.UTF_8, vararg options: OpenOption): InputStreamReader

Возвращает новый InputStreamReader для чтения содержимого этого файла.

readLines

В Kotlin начиная с: 1.5

inline fun Path.readLines(charset: Charset = Charsets.UTF_8): List<String>

Считывает содержимое файла в виде списка строк.

readSymbolicLink

В Kotlin начиная с: 1.5

inline fun Path.readSymbolicLink(): Path

Считывает цель символической ссылки, указанной этим путем.

readText

В Kotlin начиная с: 1.5

fun Path.readText(charset: Charset = Charsets.UTF_8): String

Возвращает все содержимое этого файла в виде строки String, используя UTF-8 или указанную кодировку.

relativeTo

Начиная с Kotlin: 1.5

fun Path.relativeTo(base: Path): Path

Вычисляет относительный путь для этого пути относительно базового пути.

relativeToOrNull

Начиная с Kotlin: 1.5

fun Path.relativeToOrNull(base: Path): Path?

Вычисляет относительный путь для этого пути относительно базового пути.

relativeToOrSelf

Начиная с Kotlin: 1.5

fun Path.relativeToOrSelf(base: Path): Path

Вычисляет относительный путь для этого пути относительно базового пути.

setAttribute

Начиная с Kotlin: 1.5


@IgnorableReturnValue
inline fun Path.setAttribute(attribute: String, value: Any?, vararg options: LinkOption): Path

Задаёт значение атрибута файла.

setLastModifiedTime

Начиная с Kotlin: 1.5


@IgnorableReturnValue
inline fun Path.setLastModifiedTime(value: FileTime): Path

Задаёт атрибут времени последнего изменения для файла, указанного этим путём.

setOwner

Начиная с Kotlin: 1.5


@IgnorableReturnValue
inline fun Path.setOwner(value: UserPrincipal): Path

Задаёт для файла указанного владельца.

setPosixFilePermissions

Начиная с Kotlin: 1.5


@IgnorableReturnValue
inline fun Path.setPosixFilePermissions(value: Set<PosixFilePermission>): Path

Задаёт разрешения POSIX для файла, указанного этим путём.

toPath

Начиная с Kotlin: 1.5

inline fun URI.toPath(): Path

Преобразует этот URI в объект Path.

useDirectoryEntries

Начиная с Kotlin: 1.5


@IgnorableReturnValue
inline fun <T> Path.useDirectoryEntries(glob: String = "*", block: (Sequence<Path>) -> T): T

Вызывает функцию обратного вызова block, передавая ей последовательность всех записей этого каталога, при необходимости отфильтрованных по соответствию указанному шаблону glob.

useLines

Начиная с Kotlin: 1.5


@IgnorableReturnValue
inline fun <T> Path.useLines(charset: Charset = Charsets.UTF_8, block: (Sequence<String>) -> T): T

Вызывает функцию обратного вызова block, передавая ей последовательность всех строк этого файла, и закрывает средство чтения после завершения обработки.

visitFileTree

Начиная с Kotlin: 2.1

fun Path.visitFileTree(visitor: FileVisitor<Path>, maxDepth: Int = Int.MAX_VALUE, followLinks: Boolean = false)

Посещает этот каталог и всё его содержимое с помощью указанного обходчика.

fun Path.visitFileTree(maxDepth: Int = Int.MAX_VALUE, followLinks: Boolean = false, builderAction: FileVisitorBuilder.() -> Unit)

Посещает этот каталог и всё его содержимое с помощью FileVisitor, заданного в builderAction.

walk

Начиная с Kotlin: 2.1

fun Path.walk(vararg options: PathWalkOption): Sequence<Path>

Возвращает последовательность путей для обхода этого каталога и всего его содержимого.

writeBytes

Начиная с Kotlin: 1.5

inline fun Path.writeBytes(array: ByteArray, vararg options: OpenOption)

Записывает в этот файл массив байтов.

writeLines

Начиная с Kotlin: 1.5


@IgnorableReturnValue
inline fun Path.writeLines(lines: Iterable<CharSequence>, charset: Charset = Charsets.UTF_8, vararg options: OpenOption): Path

Записывает в файл указанную коллекцию строк — последовательностей символов, завершая каждую из них разделителем строк платформы.


@IgnorableReturnValue
inline fun Path.writeLines(lines: Sequence<CharSequence>, charset: Charset = Charsets.UTF_8, vararg options: OpenOption): Path

Записывает в файл указанную последовательность строк — последовательностей символов, завершая каждую из них разделителем строк платформы.

writer

Начиная с Kotlin: 1.5

inline fun Path.writer(charset: Charset = Charsets.UTF_8, vararg options: OpenOption): OutputStreamWriter

Возвращает новый OutputStreamWriter для записи содержимого этого файла.

writeText

Начиная с Kotlin: 1.5

fun Path.writeText(text: CharSequence, charset: Charset = Charsets.UTF_8, vararg options: OpenOption)

Задаёт текстовое содержимое этого файла в кодировке UTF-8 или указанной кодировке.

© 2010–2026 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.io.path/index.html