http4k-config/org.http4k.config

Package-level declarations

Types

data class Authority(val host: Host, val port: Port? = null)

This models the runtime environment of the shell where the app is running. Optionally pass a separator to use for multi-values otherwise a standard comma is used - this means you MUST override the separator if you have single values which contain commas, otherwise singular environment keys will just retrieve the first value.

EnvironmentKey

object EnvironmentKey : BiDiLensSpec<Environment, String>

This models the key used to get a value out of the Environment using the standard Lens mechanic. Note that if your values contain commas, either use a EnvironmentKey.(mapping).multi.required()/optional()/defaulted() to retrieve the entire list, or override the comma separator in your initial Environment.

Host

data class Host(val value: String)

MapEnvironment

class MapEnvironment : Environment

Port

data class Port(val value: Int)

Secret

class Secret(input: ByteArray) : Closeable

A secret is a value which tries very hard not to expose itself as a string, by storing it's value in a byte array. You can "use" the value only once, after which the value is destroyed

Timeout

data class Timeout(val value: Duration)

Functions

enum

inline fun <T : Enum<T>> EnvironmentKey.enum(caseSensitive: Boolean = true): BiDiLensSpec<Environment, T>

fromConfigFile

fun Environment.Companion.fromConfigFile(file: File): Environment

fromYaml

fun Environment.Companion.fromYaml(file: File): Environment

Read a YAML file into environments, prepending all of the nested levels into the property names

fun Environment.Companion.fromYaml(resource: String): Environment

Read a YAML file from resources into environments, prepending all of the nested levels into the property names