file/io.matthewnelson.kmp.file/InterruptedIOException

InterruptedIOException

expect open class InterruptedIOException : IOException(source)

Signals that an I/O operation has been interrupted. An InterruptedIOException is thrown to indicate that an input or output transfer has been terminated because the thread performing it was interrupted. The field bytesTransferred indicates how many bytes were successfully transferred before the interruption occurred.

See also

actual typealias InterruptedIOException = java.io.InterruptedIOException(source)
actual open class InterruptedIOException : IOException(source)

Signals that an I/O operation has been interrupted. An InterruptedIOException is thrown to indicate that an input or output transfer has been terminated because the thread performing it was interrupted. The field bytesTransferred indicates how many bytes were successfully transferred before the interruption occurred.

See also

Constructors

Link copied to clipboard
expect constructor()
expect constructor(message: String?)
actual constructor()
actual constructor(message: String?)

Properties

Link copied to clipboard
expect var InterruptedIOException.bytesTransferred: Int

Reports how many bytes had been transferred as part of the I/O operation before it was interrupted.

actual var InterruptedIOException.bytesTransferred: Int

Reports how many bytes had been transferred as part of the I/O operation before it was interrupted.

actual var InterruptedIOException.bytesTransferred: Int

Reports how many bytes had been transferred as part of the I/O operation before it was interrupted.

cause
Link copied to clipboard
open val cause: Throwable?
open val cause: Throwable?
Link copied to clipboard
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
Link copied to clipboard
open val message: String?
open val message: String?

Functions

Link copied to clipboard
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.

Link copied to clipboard
@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.