kone.plugin.contexts.runtime/dev.lounres.kone.contexts

Package-level declarations

Types

KoneContextExclude

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class KoneContextExclude

Marks a property to be excluded from the context registry during contexts plugin processing.

KoneContextInclude

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class KoneContextInclude

Marks a property of a class, an interface, or an object to be included in unwrapping of the containing class/interface/object during the call of localUnwrap or koneLocalUnwrap.

Functions

koneLocalUnwrap

@JvmName(name = "koneLocalUnwrapContextual")

context(koneContextRegistry: KoneContextRegistry)
fun koneLocalUnwrap(vararg keys: RegistryKey<out KoneContext>)

This function is a stub that is replaced at compile time by the Kone contexts compiler plugin. It "unwraps" values corresponding to the specified keys in the KoneContextRegistry context parameter.

koneLocalUnwrap

fun KoneContextRegistry.koneLocalUnwrap(vararg keys: RegistryKey<out KoneContext>)

This function is a stub that is replaced at compile time by the Kone contexts compiler plugin. It "unwraps" values corresponding to the specified keys in the KoneContextRegistry receiver.

localContexts

fun localContexts(vararg contexts: Any?)

Runtime declaration for the localContexts contexts plugin function.

localReceivers

fun localReceivers(vararg receivers: Any?)

Runtime declaration for the localReceivers contexts plugin function.

localUnwrap

fun KoneContext.Companion.localUnwrap(vararg koneContexts: KoneContext)

This function is a stub that is replaced at compile time by the Kone contexts compiler plugin. It "unwraps" the provided koneContexts into their underlying KoneContext instances.