kotlin-stdlib/kotlin.coroutines.cancellation/CancellationException

CancellationException

expect open class CancellationException : IllegalStateException(source)

Thrown by cancellable suspending functions if the coroutine is cancelled while it is suspended. It indicates normal cancellation of a coroutine.

Since Kotlin

1.4

actual open class CancellationException : IllegalStateException(source)

Since Kotlin

1.4

actual typealias CancellationException = java.util.concurrent.CancellationException(source)

Since Kotlin

1.4

actual open class CancellationException : IllegalStateException(source)

Since Kotlin

1.4

actual open class CancellationException : IllegalStateException(source)

Since Kotlin

1.8

actual open class CancellationException : IllegalStateException(source)

Since Kotlin

1.8

Constructors

CancellationException

expect constructor()

expect constructor(message: String?)

constructor(message: String?, cause: Throwable?)

constructor(cause: Throwable?)

actual constructor()

actual constructor(message: String?)

constructor(message: String?, cause: Throwable?)

constructor(cause: Throwable?)

actual constructor()

actual constructor(message: String?)

constructor(message: String?, cause: Throwable?)

constructor(cause: Throwable?)

actual constructor()

actual constructor(message: String?)

constructor(message: String?, cause: Throwable?)

constructor(cause: Throwable?)

actual constructor()

actual constructor(message: String?)

Properties

expect open val cause: Throwable?

Since Kotlin 1.4

actual open val cause: Throwable?

Since Kotlin 1.4

actual open val cause: Throwable?

Since Kotlin 1.4

actual open val cause: Throwable?

Since Kotlin 1.8

actual open val cause: Throwable?

Since Kotlin 1.8

expect open val message: String?

Since Kotlin 1.4

actual open val message: String?

Since Kotlin 1.4

actual open val message: String?

Since Kotlin 1.4

actual open val message: String?

Since Kotlin 1.8

actual open val message: String?

Since Kotlin 1.8

val Throwable.stackTrace: Array<StackTraceElement>

Returns an array of stack trace elements representing the stack trace pertaining to this throwable.

Since Kotlin 1.0

suppressedExceptions

expect val Throwable.suppressedExceptions: List<Throwable>

Returns a list of all exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.4

actual val Throwable.suppressedExceptions: List<Throwable>

Returns a list of all exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.4

actual val Throwable.suppressedExceptions: List<Throwable>

Returns a list of all exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.4

actual val Throwable.suppressedExceptions: List<Throwable>

Returns a list of all exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.4

actual val Throwable.suppressedExceptions: List<Throwable>

Returns a list of all exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.8

actual val Throwable.suppressedExceptions: List<Throwable>

Returns a list of all exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.8

Functions

expect fun Throwable.addSuppressed(exception: Throwable)

When supported by the platform, adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.4

actual fun Throwable.addSuppressed(exception: Throwable)

Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.4

actual fun Throwable.addSuppressed(exception: Throwable)

When supported by the platform, adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.1

actual fun Throwable.addSuppressed(exception: Throwable)

Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.4

actual fun Throwable.addSuppressed(exception: Throwable)

Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.8

actual fun Throwable.addSuppressed(exception: Throwable)

Adds the specified exception to the list of exceptions that were suppressed in order to deliver this exception.

Since Kotlin 1.8

@ExperimentalNativeApi

fun getStackTrace(): Array<String>

Returns an array of stack trace strings representing the stack trace pertaining to this throwable.

Since Kotlin 1.4

getStackTraceAddresses

@ExperimentalNativeApi

fun Throwable.getStackTraceAddresses(): List<Long>

Returns a list of stack trace addresses representing the stack trace pertaining to this throwable.

Since Kotlin 1.3

printStackTrace

fun printStackTrace()

Prints the detailed description of this throwable to the standard error output.

Since Kotlin 1.4

printStackTrace

expect fun Throwable.printStackTrace()

Prints the detailed description of this throwable to the standard output or standard error output.

Since Kotlin 1.4

actual fun Throwable.printStackTrace()

Prints the detailed description of this throwable to console error output.

Since Kotlin 1.4

actual inline fun Throwable.printStackTrace()

Prints the detailed description of this throwable to the standard error output.

Since Kotlin 1.0

inline fun Throwable.printStackTrace(stream: PrintStream)

Prints the detailed description of this throwable to the specified stream.

Since Kotlin 1.0

inline fun Throwable.printStackTrace(writer: PrintWriter)

Prints the detailed description of this throwable to the specified writer.

Since Kotlin 1.0

actual inline fun Throwable.printStackTrace()

Prints the detailed description of this throwable to the standard error output.

Since Kotlin 1.4

actual fun Throwable.printStackTrace()

Prints the detailed description of this throwable to console error output.

Since Kotlin 1.8

actual fun Throwable.printStackTrace()

Prints the detailed description of this throwable to console error output.

Since Kotlin 1.8

stackTraceToString

expect fun Throwable.stackTraceToString(): String

Returns the detailed description of this throwable with its stack trace.

Since Kotlin 1.4

actual fun Throwable.stackTraceToString(): String

Returns the detailed description of this throwable with its stack trace.

Since Kotlin 1.4

actual fun Throwable.stackTraceToString(): String

Returns the detailed description of this throwable with its stack trace.

Since Kotlin 1.4

actual fun Throwable.stackTraceToString(): String

Returns the detailed description of this throwable with its stack trace.

Since Kotlin 1.4

actual fun Throwable.stackTraceToString(): String

Returns the detailed description of this throwable with its stack trace.

Since Kotlin 1.8

actual fun Throwable.stackTraceToString(): String

Returns the detailed description of this throwable with its stack trace.

Since Kotlin 1.8

open override fun toString(): String

Since Kotlin 1.4

open override fun toString(): String

Returns the short description of this throwable consisting of the exception class name (fully qualified if possible) followed by the exception message if it is not null.

Since Kotlin 1.4

open override fun toString(): String

Returns the short description of this throwable consisting of the exception class name followed by the exception message if it is not null.

Since Kotlin 1.8

open override fun toString(): String

Returns the short description of this throwable consisting of the exception class name followed by the exception message if it is not null.

Since Kotlin 1.8

Thanks for your feedback!

Was this page helpful?