modulecheck-utils:trace/modulecheck.utils.trace

Package-level declarations

Types

Convenience interface for providing static tags to a Trace, then consuming them via a traced extension.

sealed class Trace(val tags: List<String>) : CoroutineContext.Element

Models a curated call stack from some root, up to this Trace node. In practice, the root will be ModuleCheckRunner.run.

Functions

requireTrace

fun CoroutineContext.requireTrace(): Trace

Unsafe-ish extension for extracting a Trace from inside a coroutine.

trace

suspend fun trace(): Trace

Unsafe-ish extension for extracting a Trace from inside a coroutine.

traced

suspend fun <T> traced(tags: Iterable<Any>, args: Iterable<Any>, block: suspend CoroutineScope.() -> T): T

Creates a Trace child node from outside a HasTraceTags implementation.

traced

suspend fun <T> HasTraceTags.traced(vararg args: Any, block: suspend CoroutineScope.() -> T): T

suspend fun <T> HasTraceTags.traced(args: Iterable<Any>, block: suspend CoroutineScope.() -> T): T

Creates a Trace child node from inside a HasTraceTags implementation.

suspend fun <T> HasTraceTags.~~traced~~(tags: Iterable<Any>, args: Iterable<Any>, block: suspend CoroutineScope.() -> T): T

Don't use. This overload exists in order to prevent accidentally providing the wrong tags to a Trace from inside a HasTraceTags. If you need to provide runtime

tracedInternal

private suspend fun <T> tracedInternal(tags: Iterable<Any>, args: Iterable<Any>, block: suspend CoroutineScope.() -> T): T

traceOrNull

internal suspend fun traceOrNull(): Trace?