konstant-core/io.github.fiol_dev.konstant.core/ConfigReport

ConfigReport

class ConfigReport<out T>(val result: ConfigResult<T>, val entries: List<ConfigReport.Entry>)(source)

The outcome of ConfigLoader.explain: the load result plus, for each field in load order, its key, the value used and where it came from. toString renders a table.

Constructors

ConfigReport

constructor(result: ConfigResult<T>, entries: List<ConfigReport.Entry>)

Types

Companion

object Companion

Entry

class Entry(val key: String, val value: String?, val origin: String, val sourceKey: String? = null)

One field. key is the field's key in dot.notation (api.port), or its @Key as written, the same for every entry whichever source supplied it. origin is the source that supplied it (#2 TomlSource(config.toml), numbered in priority order), DEFAULT or MISSING. sourceKey is the key that source was asked for when it differs from key, such as API_PORT in environment variables. value is the raw text, *** for secrets, or null when missing. A plain class rather than a data class, so fields can be added later; entries still compare by value.

Properties

entries

val entries: List<ConfigReport.Entry>

One entry per field, in load order.

result

val result: ConfigResult<T>

What the load returned, including any errors.

Functions

toString

open override fun toString(): String