blob: a9c68f090a0451c520c74b3c22893146a67a8848 (
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:Suppress("DEPRECATION_ERROR")
package kotlinx.coroutines
import kotlinx.coroutines.selects.*
import kotlin.coroutines.*
/**
* A non-cancelable job that is always [active][Job.isActive]. It is designed for [withContext] function
* to prevent cancellation of code blocks that need to be executed without cancellation.
*
* Use it like this:
* ```
* withContext(NonCancellable) {
* // this code will not be cancelled
* }
* ```
*/
public object NonCancellable : AbstractCoroutineContextElement(Job), Job {
/**
* Always returns `true`.
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override val isActive: Boolean get() = true
/**
* Always returns `false`.
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override val isCompleted: Boolean get() = false
/**
* Always returns `false`.
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override val isCancelled: Boolean get() = false
/**
* Always returns `false`.
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override fun start(): Boolean = false
/**
* Always throws [UnsupportedOperationException].
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override suspend fun join() {
throw UnsupportedOperationException("This job is always active")
}
/**
* Always throws [UnsupportedOperationException].
* @suppress **This an internal API and should not be used from general code.**
*/
override val onJoin: SelectClause0
get() = throw UnsupportedOperationException("This job is always active")
/**
* Always throws [IllegalStateException].
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override fun getCancellationException(): CancellationException = throw IllegalStateException("This job is always active")
/**
* @suppress **This an internal API and should not be used from general code.**
*/
@Suppress("OverridingDeprecatedMember")
@InternalCoroutinesApi
override fun invokeOnCompletion(handler: CompletionHandler): DisposableHandle =
NonDisposableHandle
/**
* Always returns no-op handle.
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override fun invokeOnCompletion(onCancelling: Boolean, invokeImmediately: Boolean, handler: CompletionHandler): DisposableHandle =
NonDisposableHandle
/**
* Does nothing.
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override fun cancel(cause: CancellationException?) {}
/**
* Always returns `false`.
* @suppress This method has bad semantics when cause is not a [CancellationException]. Use [cancel].
*/
@Deprecated(level = DeprecationLevel.HIDDEN, message = "Since 1.2.0, binary compatibility with versions <= 1.1.x")
override fun cancel(cause: Throwable?): Boolean = false // never handles exceptions
/**
* Always returns [emptySequence].
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override val children: Sequence<Job>
get() = emptySequence()
/**
* Always returns [NonDisposableHandle] and does not do anything.
* @suppress **This an internal API and should not be used from general code.**
*/
@InternalCoroutinesApi
override fun attachChild(child: ChildJob): ChildHandle = NonDisposableHandle
/** @suppress */
override fun toString(): String {
return "NonCancellable"
}
}
|
