Объявления уровня пакета
API ввода-вывода для работы с файлами и потоками.
Типы
Требования к платформе и версии: JVM (1.0)
class AccessDeniedException(file: File, other: File? = null, reason: String? = null) : FileSystemException
Класс исключения, используемый, когда у нас недостаточно прав доступа для выполнения какой-либо операции.
Требования к платформе и версии: JVM (1.0)
class FileAlreadyExistsException(file: File, other: File? = null, reason: String? = null) : FileSystemException
Класс исключения, используемый, когда файл, который нужно создать или скопировать, уже существует.
Требования к платформе и версии: JVM (1.0)
open class FileSystemException(val file: File, val other: File? = null, val reason: String? = null) : IOException
Базовый класс исключений файловой системы.
Требования к платформе и версии: JVM (1.0)
class FileTreeWalk : Sequence<File>
Этот класс предназначен для реализации различных способов обхода файлов. Он позволяет перебирать все файлы в заданном каталоге.
Требования к платформе и версии: JVM (1.0)
enum FileWalkDirection : Enum<FileWalkDirection>
Перечисление для описания возможных направлений обхода. Их два: от родительских элементов к дочерним и от дочерних к родительским. В обоих случаях используется поиск в глубину.
Требования к платформе и версии: JVM (1.0)
class NoSuchFileException(file: File, other: File? = null, reason: String? = null) : FileSystemException
Класс исключения, используемый, когда файл, который нужно скопировать, не существует.
Требования к платформе и версии: JVM (1.0)
enum OnErrorAction : Enum<OnErrorAction>
Перечисление, которое можно использовать для задания поведения функции copyRecursively() в случае исключительных ситуаций.
Свойства
Требования к платформе и версии: JVM (1.0)
const val DEFAULT_BUFFER_SIZE: Int
Возвращает размер буфера по умолчанию при работе с буферизованными потоками.
Требования к платформе и версии: JVM (1.0)
val File.invariantSeparatorsPath: String
Возвращает путь этого файла, используя инвариантный разделитель «/» для разделения имён в последовательности имён.
Требования к платформе и версии: JVM (1.0)
val File.nameWithoutExtension: String
Возвращает имя файла без расширения.
Функции
Требования к платформе и версии: JVM (1.0)
fun File.appendBytes(array: ByteArray)
Добавляет массив байтов к содержимому этого файла.
Требования к платформе и версии: JVM (1.0)
inline fun InputStream.buffered(bufferSize: Int = DEFAULT_BUFFER_SIZE): BufferedInputStream
Создает BufferedInputStream, оборачивающий этот поток.
inline fun OutputStream.buffered(bufferSize: Int = DEFAULT_BUFFER_SIZE): BufferedOutputStream
Создает BufferedOutputStream, оборачивающий этот поток.
inline fun Reader.buffered(bufferSize: Int = DEFAULT_BUFFER_SIZE): BufferedReader
Возвращает BufferedReader, оборачивающий этот Reader, или сам этот Reader, если он уже буферизован.
inline fun Writer.buffered(bufferSize: Int = DEFAULT_BUFFER_SIZE): BufferedWriter
Возвращает BufferedWriter, оборачивающий этот Writer, или сам этот Writer, если он уже буферизован.
Требования к платформе и версии: JVM (1.0)
inline fun InputStream.bufferedReader(charset: Charset = Charsets.UTF_8): BufferedReader
Создает BufferedReader для этого входного потока в кодировке UTF-8 или указанной кодировке.
inline fun File.bufferedReader(charset: Charset = Charsets.UTF_8, bufferSize: Int = DEFAULT_BUFFER_SIZE): BufferedReader
Возвращает новый BufferedReader для чтения содержимого этого файла.
Требования к платформе и версии: JVM (1.0)
inline fun OutputStream.bufferedWriter(charset: Charset = Charsets.UTF_8): BufferedWriter
Создает BufferedWriter для этого выходного потока в кодировке UTF-8 или указанной кодировке.
inline fun File.bufferedWriter(charset: Charset = Charsets.UTF_8, bufferSize: Int = DEFAULT_BUFFER_SIZE): BufferedWriter
Возвращает новый BufferedWriter для записи содержимого этого файла.
Требования к платформе и версии: JVM (1.0)
inline fun String.byteInputStream(charset: Charset = Charsets.UTF_8): ByteArrayInputStream
Создает новый байтовый входной поток для строки.
Требования к платформе и версии: JVM (1.0)
fun File.copyRecursively(target: File, overwrite: Boolean = false, onError: (File, IOException) -> OnErrorAction = { _, exception -> throw exception }): Boolean
Копирует этот файл со всеми его дочерними элементами по указанному пути назначения target. Если на пути к месту назначения отсутствуют какие-либо каталоги, они будут созданы.
Требования к платформе и версии: JVM (1.0)
fun InputStream.copyTo(out: OutputStream, bufferSize: Int = DEFAULT_BUFFER_SIZE): Long
Копирует этот поток в указанный выходной поток и возвращает количество скопированных байтов
fun Reader.copyTo(out: Writer, bufferSize: Int = DEFAULT_BUFFER_SIZE): Long
Копирует содержимое этого средства чтения в указанный выходной поток записи и возвращает количество скопированных символов.
fun File.copyTo(target: File, overwrite: Boolean = false, bufferSize: Int = DEFAULT_BUFFER_SIZE): File
Копирует этот файл в указанный файл назначения.
Требования к платформе и версии: JVM (1.0)
fun File.deleteRecursively(): Boolean
Удаляет этот файл вместе со всеми его дочерними элементами. Обратите внимание, что при сбое операции удаление может быть выполнено частично.
Требования к платформе и версии: JVM (1.0)
fun File.endsWith(other: File): Boolean
Определяет, заканчивается ли путь к этому файлу путем другого файла other.
fun File.endsWith(other: String): Boolean
Определяет, принадлежит ли этот файл тому же корню, что и other, и заканчивается ли он всеми компонентами other в том же порядке. Таким образом, если other содержит N компонентов, последние N компонентов this должны совпадать с компонентами other. Если other является относительным путем, this может принадлежать любому корню.
Требования к платформе и версии: JVM (1.0)
fun File.forEachBlock(action: (buffer: ByteArray, bytesRead: Int) -> Unit)
Читает файл блоками байтов и вызывает action для каждого прочитанного блока. Размер блока по умолчанию зависит от реализации. Эта функция передает массив байтов и количество байтов в массиве функции action.
fun File.forEachBlock(blockSize: Int, action: (buffer: ByteArray, bytesRead: Int) -> Unit)
Требования к платформе и версии: JVM (1.0)
fun Reader.forEachLine(action: (String) -> Unit)
Перебирает все строки этого средства чтения, вызывает action для каждой прочитанной строки и по завершении закрывает Reader.
fun File.forEachLine(charset: Charset = Charsets.UTF_8, action: (line: String) -> Unit)
Требования к платформе и версии: JVM (1.0)
inline fun File.inputStream(): FileInputStream
Создает новый FileInputStream для этого файла и возвращает его.
inline fun ByteArray.inputStream(): ByteArrayInputStream
Создает входной поток для чтения данных из этого байтового массива.
inline fun ByteArray.inputStream(offset: Int, length: Int): ByteArrayInputStream
Создает входной поток для чтения данных из указанной части этого байтового массива.
Требования к платформе и версии: JVM (1.0)
operator fun BufferedInputStream.iterator(): ByteIterator
Возвращает Iterator байтов, прочитанных из этого входного потока.
Требования к платформе и версии: JVM (1.0)
fun BufferedReader.lineSequence(): Sequence<String>
Возвращает последовательность соответствующих строк файла.
Требования к платформе и версии: JVM (1.0)
inline fun File.outputStream(): FileOutputStream
Создает новый FileOutputStream для этого файла и возвращает его.
Требования к платформе и версии: Common (1.0), JS (1.1), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)
expect fun print(message: Any?)
Выводит указанное сообщение в стандартный поток вывода.
Требования к платформе и версии: JVM (1.0)
actual inline fun print(message: Any?)
inline fun print(message: Boolean)
inline fun print(message: Byte)
inline fun print(message: Char)
inline fun print(message: CharArray)
inline fun print(message: Double)
inline fun print(message: Float)
inline fun print(message: Int)
inline fun print(message: Long)
inline fun print(message: Short)
Выводит указанное сообщение в стандартный поток вывода.
Требования к платформе и версии: Common (1.0), JS (1.1), Wasm-JS (1.8), Wasm-WASI (1.8)
expect fun println()
Выводит разделитель строк в стандартный поток вывода.
expect fun println(message: Any?)
Выводит указанное сообщение и разделитель строк в стандартный поток вывода.
Требования к платформе и версии: JVM (1.0)
actual inline fun println()
Выводит разделитель строк в стандартный поток вывода.
actual inline fun println(message: Any?)
inline fun println(message: Boolean)
inline fun println(message: Byte)
inline fun println(message: Char)
inline fun println(message: CharArray)
inline fun println(message: Double)
inline fun println(message: Float)
inline fun println(message: Int)
inline fun println(message: Long)
inline fun println(message: Short)
Выводит указанное сообщение и разделитель строк в стандартный поток вывода.
Требования к платформе и версии: Native (1.3)
actual external fun println()
Выводит разделитель строк в стандартный поток вывода.
actual fun println(message: Any?)
Выводит указанное сообщение и разделитель строк в стандартный поток вывода.
Требования к платформе и версии: JVM (1.0)
inline fun File.printWriter(charset: Charset = Charsets.UTF_8): PrintWriter
Возвращает новый PrintWriter для записи содержимого этого файла.
Требования к платформе и версии: JVM (1.0)
fun File.readBytes(): ByteArray
Получает все содержимое этого файла в виде массива байтов.
fun InputStream.readBytes(): ByteArray
Полностью считывает этот поток в массив байтов.
fun URL.readBytes(): ByteArray
Считывает все содержимое URL в виде массива байтов.
fun InputStream.readBytes(estimatedSize: Int = DEFAULT_BUFFER_SIZE): ByteArray
Полностью считывает этот поток в массив байтов.
Требования к платформе и версии: JVM (1.0)
inline fun String.reader(): StringReader
Создает новое средство чтения для строки.
inline fun File.reader(charset: Charset = Charsets.UTF_8): InputStreamReader
Возвращает новый FileReader для чтения содержимого этого файла.
inline fun InputStream.reader(charset: Charset = Charsets.UTF_8): InputStreamReader
Создает средство чтения для этого входного потока в кодировке UTF-8 или указанной кодировке.
Требования к платформе и версии: Common (1.6), JVM (1.6), Native (1.6), Wasm-WASI (1.8)
expect fun readln(): String
Считывает строку ввода из стандартного потока ввода и возвращает ее либо выбрасывает RuntimeException, если к моменту вызова readln уже достигнут конец файла (EOF).
Требования к платформе и версии: JS (1.6)
actual fun readln(): String
Эта функция не поддерживается в Kotlin/JS и выбрасывает UnsupportedOperationException.
Требования к платформе и версии: Wasm-JS (1.8)
actual fun readln(): String
Эта функция не поддерживается в Kotlin/Wasm и выбрасывает UnsupportedOperationException.
Требования к платформе и версии: Common (1.6), JVM (1.6), Wasm-WASI (1.8)
expect fun readlnOrNull(): String?
Считывает строку ввода из стандартного потока ввода и возвращает ее либо возвращает null, если к моменту вызова readlnOrNull уже достигнут конец файла (EOF).
Требования к платформе и версии: JS (1.6)
actual fun readlnOrNull(): String?
Эта функция не поддерживается в Kotlin/JS и выбрасывает UnsupportedOperationException.
Требования к платформе и версии: Native (1.6)
actual external fun readlnOrNull(): String?
Считывает строку ввода из стандартного потока ввода и возвращает ее либо возвращает null, если к моменту вызова readlnOrNull уже достигнут конец файла (EOF).
Требования к платформе и версии: Wasm-JS (1.8)
actual fun readlnOrNull(): String?
Эта функция не поддерживается в Kotlin/Wasm и выбрасывает UnsupportedOperationException.
Требования к платформе и версии: JVM (1.0)
fun Reader.readText(): String
Полностью считывает содержимое этого средства чтения в виде строки.
fun File.readText(charset: Charset = Charsets.UTF_8): String
Получает все содержимое этого файла в виде строки, используя кодировку UTF-8 или указанную кодировку.
inline fun URL.readText(charset: Charset = Charsets.UTF_8): String
Считывает все содержимое этого URL в виде строки, используя кодировку UTF-8 или указанную кодировку.
Требования к платформе и версии: JVM (1.0)
fun File.resolve(relative: File): File
Добавляет относительный файл к этому, рассматривая этот файл как каталог. Если относительный путь имеет корень, возвращается сам относительный путь. Например, File("/foo/bar").resolve(File("gav")) — это File("/foo/bar/gav"). Эта функция дополняет relativeTo, поэтому f.resolve(g.relativeTo(f)) == g всегда должно быть true, за исключением случая с разными корнями.
fun File.resolve(relative: String): File
Добавляет относительное имя к этому, рассматривая этот путь как каталог. Если относительный путь имеет корень, возвращается сам относительный путь. Например, File("/foo/bar").resolve("gav") — это File("/foo/bar/gav").
Требования к платформе и версии: JVM (1.0)
fun File.resolveSibling(relative: File): File
Добавляет относительный файл к родительскому каталогу этого файла. Если относительный путь имеет корень или у этого файла нет родительского каталога, возвращается сам относительный путь. Например, File("/foo/bar").resolveSibling(File("gav")) — это File("/foo/gav").
fun File.resolveSibling(relative: String): File
Добавляет относительное имя к родительскому каталогу этого файла. Если относительный путь имеет корень или у этого файла нет родительского каталога, возвращается сам относительный путь. Например, File("/foo/bar").resolveSibling("gav") — это File("/foo/gav").
Требования к платформе и версии: JVM (1.0)
fun File.startsWith(other: File): Boolean
fun File.startsWith(other: String): Boolean
Требования к платформе и версии: JVM (1.0)
inline fun <T> Reader.useLines(block: (Sequence<String>) -> T): T
inline fun <T> File.useLines(charset: Charset = Charsets.UTF_8, block: (Sequence<String>) -> T): T
Вызывает обратный вызов блока, передавая ему последовательность всех строк этого файла, и закрывает средство чтения после завершения обработки.
Требования к платформе и версии: JVM (1.0)
fun File.walk(direction: FileWalkDirection = FileWalkDirection.TOP_DOWN): FileTreeWalk
Возвращает последовательность для обхода этого каталога и всего его содержимого.
Требования к платформе и версии: JVM (1.0)
fun File.walkBottomUp(): FileTreeWalk
Возвращает последовательность для обхода этого каталога и всего его содержимого в порядке снизу вверх. Используется поиск в глубину, а каталоги посещаются после всех файлов в них.
Требования к платформе и версии: JVM (1.0)
fun File.walkTopDown(): FileTreeWalk
Возвращает последовательность для обхода этого каталога и всего его содержимого в порядке сверху вниз. Используется поиск в глубину, а каталоги посещаются до всех файлов в них.
Требования к платформе и версии: JVM (1.0)
fun File.writeBytes(array: ByteArray)
Задаёт содержимое этого файла в виде массива байтов. Если файл уже существует, его содержимое перезаписывается.
Требования к платформе и версии: JVM (1.0)
inline fun File.writer(charset: Charset = Charsets.UTF_8): OutputStreamWriter
Возвращает новый FileWriter для записи содержимого этого файла.
inline fun OutputStream.writer(charset: Charset = Charsets.UTF_8): OutputStreamWriter
Создаёт средство записи для этого выходного потока с использованием 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/index.html
