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

ConfigResult

sealed class ConfigResult<out T>(source)

The outcome of loading a config: Success with the value, or Failure with every error found. Loading does not stop at the first bad key, so all problems are reported at once.

Inheritors

Success

Failure

Types

Failure

data class Failure(val errors: List<ConfigError>) : ConfigResult<Nothing>

The config could not be loaded; errors lists each failed key.

Success

data class Success<T>(val value: T) : ConfigResult<T>

The config loaded and passed validation.

Functions

getOrElse

fun getOrElse(fallback: T): T

The value, or fallback on failure.

getOrNull

fun getOrNull(): T?

The value, or null on failure.

getOrThrow

fun getOrThrow(): T

The value, or throws ConfigException with all the errors.

map

fun <R> map(transform: (T) -> R): ConfigResult<R>

Transforms the value of a Success; a Failure is returned unchanged.

onFailure

fun onFailure(action: (List<ConfigError>) -> Unit): ConfigResult<T>

Runs action with the errors if this is a Failure, then returns this result.