blob: 185ad295d8667e0ff6e3176d4831037c658a6397 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
/*
* Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.coroutines
internal expect val DEBUG: Boolean
internal expect val Any.hexAddress: String
internal expect val Any.classSimpleName: String
internal expect fun assert(value: () -> Boolean)
/**
* Throwable which can be cloned during stacktrace recovery in a class-specific way.
* For additional information about stacktrace recovery see [STACKTRACE_RECOVERY_PROPERTY_NAME]
*
* Example of usage:
* ```
* class BadResponseCodeException(val responseCode: Int) : Exception(), CopyableThrowable<BadResponseCodeException> {
*
* override fun createCopy(): BadResponseCodeException {
* val result = BadResponseCodeException(responseCode)
* result.initCause(this)
* return result
* }
* ```
*
* Copy mechanism is used only on JVM, but it might be convenient to implement it in common exceptions,
* so on JVM their stacktraces will be properly recovered.
*/
@ExperimentalCoroutinesApi // Since 1.2.0, no ETA on stability
public interface CopyableThrowable<T> where T : Throwable, T : CopyableThrowable<T> {
/**
* Creates a copy of the current instance.
*
* For better debuggability, it is recommended to use original exception as [cause][Throwable.cause] of the resulting one.
* Stacktrace of copied exception will be overwritten by stacktrace recovery machinery by [Throwable.setStackTrace] call.
* An exception can opt-out of copying by returning `null` from this function.
* Suppressed exceptions of the original exception should not be copied in order to avoid circular exceptions.
*
* This function is allowed to create a copy with a modified [message][Throwable.message], but it should be noted
* that the copy can be later recovered as well and message modification code should handle this situation correctly
* (e.g. by also storing the original message and checking it) to produce a human-readable result.
*/
public fun createCopy(): T?
}
|
