file/io.matthewnelson.kmp.file/EOFException

EOFException

expect open class EOFException : IOException(source)

Signals that an end of file or end of stream has been reached unexpectedly during input. This exception is mainly used by data input streams to signal end of stream. Note that many other input operations return a special value on end of stream rather than throwing an exception.

actual typealias EOFException = java.io.EOFException(source)

actual open class EOFException : IOException(source)

Constructors

EOFException

expect constructor()

expect constructor(message: String?)

actual constructor()

actual constructor(message: String?)

Properties

cause

open val cause: Throwable?

errorCodeOrNull

actual val Throwable.errorCodeOrNull: String?

Attempts to retrieve the code from an exception thrown from JavaScript. If unable to retrieve it, null is returned.

expect val Throwable.errorCodeOrNull: String?

Attempts to retrieve the code from an exception thrown from JavaScript. If unable to retrieve it, null is returned.

actual val Throwable.errorCodeOrNull: String?

Attempts to retrieve the code from an exception thrown from JavaScript. If unable to retrieve it, null is returned.

message

open val message: String?

Functions

toIOException

fun Throwable.toIOException(): IOException

fun Throwable.toIOException(file: File?, other: File? = null): IOException

Converts the throwable to an IOException if it is not already one. When errorCodeOrNull is ENOENT, then this function will return FileNotFoundException. When the errorCodeOrNull is EINTR, then this function will return InterruptedIOException. When the errorCodeOrNull starts with ERR_FS_, then this function will return FileSystemException.

wrapIOException

@JvmName(name = "wrapIO")

inline fun Throwable.wrapIOException(): IOException

Ensures that the throwable is an instance of IOException. If it is not, it will encase it in one. If the throwable is an instance of InterruptedException, this function returns an InterruptedIOException with the InterruptedException as a suppressed exception.

@JvmName(name = "wrapIO")

inline fun Throwable.wrapIOException(lazyMessage: () -> String): IOException

Ensures that the throwable is an instance of IOException. If it is not, it will encase it in one with the provided lazyMessage. If the throwable is an instance of InterruptedException, this function returns an InterruptedIOException with the InterruptedException as a suppressed exception.