Roman Elizarov | f16fd27 | 2017-02-07 11:26:00 +0300 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-2017 JetBrains s.r.o. |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Roman Elizarov | 3754f95 | 2017-01-18 20:47:54 +0300 | [diff] [blame] | 17 | package kotlinx.coroutines.experimental |
| 18 | |
Roman Elizarov | ea4a51b | 2017-01-31 12:01:25 +0300 | [diff] [blame] | 19 | import kotlin.coroutines.experimental.AbstractCoroutineContextElement |
| 20 | import kotlin.coroutines.experimental.CoroutineContext |
Roman Elizarov | 3754f95 | 2017-01-18 20:47:54 +0300 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * User-specified name of coroutine. This name is used in debugging mode. |
| 24 | * See [newCoroutineContext] for the description of coroutine debugging facilities. |
| 25 | */ |
Roman Elizarov | f138bbc | 2017-02-09 19:13:08 +0300 | [diff] [blame] | 26 | public data class CoroutineName( |
| 27 | /** |
| 28 | * User-defined coroutine name. |
| 29 | */ |
| 30 | val name: String |
| 31 | ) : AbstractCoroutineContextElement(CoroutineName) { |
| 32 | /** |
| 33 | * Key for [CoroutineName] instance in the coroutine context. |
| 34 | */ |
Roman Elizarov | 3754f95 | 2017-01-18 20:47:54 +0300 | [diff] [blame] | 35 | public companion object Key : CoroutineContext.Key<CoroutineName> |
Roman Elizarov | f138bbc | 2017-02-09 19:13:08 +0300 | [diff] [blame] | 36 | |
| 37 | /** |
| 38 | * Returns a string representation of the object. |
| 39 | */ |
Roman Elizarov | 3754f95 | 2017-01-18 20:47:54 +0300 | [diff] [blame] | 40 | override fun toString(): String = "CoroutineName($name)" |
| 41 | } |