nativeMain.Exceptions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlinx-coroutines-core-metadata Show documentation

Coroutines support libraries for Kotlin

There is a newer version: 1.4.2-native-mt

Show newest version

/*
 * Copyright 2016-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */

package kotlinx.coroutines

import kotlinx.atomicfu.*
import kotlin.native.ref.*

/**
 * Thrown by cancellable suspending functions if the [Job] of the coroutine is cancelled while it is suspending.
 * It indicates _normal_ cancellation of a coroutine.
 * **It is not printed to console/log by default uncaught exception handler**.
 * (see [CoroutineExceptionHandler]).
 */
public actual open class CancellationException(
    message: String?,
    cause: Throwable?
) : IllegalStateException(message, cause) {
    public actual constructor(message: String?) : this(message, null)
}

/**
 * Thrown by cancellable suspending functions if the [Job] of the coroutine is cancelled or completed
 * without cause, or with a cause or exception that is not [CancellationException]
 * (see [Job.getCancellationException]).
 */
internal actual class JobCancellationException public actual constructor(
    message: String,
    cause: Throwable?,
    job: Job
) : CancellationException(message, cause) {
    private val ref = WeakReference(job)
    internal actual val job: Job?
        get() = ref.get()

    override fun toString(): String = "${super.toString()}; job=$job"
    override fun equals(other: Any?): Boolean =
        other === this ||
            other is JobCancellationException && other.message == message && other.job == job && other.cause == cause
    override fun hashCode(): Int =
        (message!!.hashCode() * 31 + job.hashCode()) * 31 + (cause?.hashCode() ?: 0)
}

internal actual fun Throwable.addSuppressedThrowable(other: Throwable) {
    if (this is SuppressSupportingThrowableImpl) addSuppressed(other)
}

// "Suppress-supporting throwable" is currently used for tests only
internal open class SuppressSupportingThrowableImpl : Throwable() {
    private val _suppressed = atomic?>(null)

    val suppressed: Array
        get() = _suppressed.value ?: emptyArray()

    fun addSuppressed(other: Throwable) {
        _suppressed.update { current ->
            if (current == null)
                arrayOf(other)
            else
                current + other
        }
    }
}

// For use in tests
internal actual val RECOVER_STACK_TRACES: Boolean = false