kotlin-stdlib/kotlin.coroutines/CoroutineContext/Element

Element

interface Element : CoroutineContext(source)

An element of the CoroutineContext. An element of the coroutine context is a singleton context by itself.

Functions

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

Accumulates entries of this context starting with initial value and applying operation from left to right to current accumulator value and each element of this context.

get

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

Returns the element with the given key from this context or null.

minusKey

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

Returns a context containing elements from this context, but without an element with the specified key.

plus

open operator fun plus(context: CoroutineContext): CoroutineContext

Returns a context containing elements from this context and elements from other context. The elements from this context with the same key as in the other one are dropped.

Properties

key

abstract val key: CoroutineContext.Key<*>

A key of this coroutine context element.

Inheritors

ContinuationInterceptor

AbstractCoroutineContextElement

Extensions

getPolymorphicElement

@ExperimentalStdlibApi

fun <E : CoroutineContext.Element> CoroutineContext.Element.getPolymorphicElement(key: CoroutineContext.Key<E>): E?

Returns the current element if it is associated with the given key in a polymorphic manner or null otherwise. This method returns non-null value if either Element.key is equal to the given key or if the key is associated with Element.key via AbstractCoroutineContextKey. See AbstractCoroutineContextKey for the example of usage.

minusPolymorphicKey

@ExperimentalStdlibApi

fun CoroutineContext.Element.minusPolymorphicKey(key: CoroutineContext.Key<*>): CoroutineContext

Returns empty coroutine context if the element is associated with the given key in a polymorphic manner or null otherwise. This method returns empty context if either Element.key is equal to the given key or if the key is associated with Element.key via AbstractCoroutineContextKey. See AbstractCoroutineContextKey for the example of usage.