Headroom.Configuration

This module provides logic for working with the cofiguration data types. Headroom uses the partial options monoid pattern for the configuration, where the Configuration is the data type for total configuration and PartialConfiguration for the partial one.

Loading & Parsing Configuration

loadConfiguration

Arguments

:: MonadIO m

=> FilePath

path to YAML configuration file

-> m PartialConfiguration

parsed configuration

Loads and parses application configuration from given YAML file.

parseConfiguration

Arguments

:: MonadThrow m

=> ByteString

raw input to parse

-> m PartialConfiguration

parsed application configuration

Parses application configuration from given raw input in YAML format.

parseVariables

Arguments

:: MonadThrow m

=> [Text]

list of raw variables

-> m (HashMap Text Text)

parsed variables

Parses variables from raw input in key=value format.

>>> parseVariables ["key1=value1"]
fromList [("key1","value1")]

Processing Partial Configuration

makeConfiguration

Arguments

:: MonadThrow m

=> PartialConfiguration

source PartialConfiguration

-> m Configuration

full Configuration

Makes full Configuration from provided PartialConfiguration (if valid).

makeHeadersConfig

Arguments

:: MonadThrow m

=> PartialHeadersConfig

source PartialHeadersConfig

-> m HeadersConfig

full HeadersConfig

Makes full HeadersConfig from provided PartialHeadersConfig (if valid).

makeHeaderConfig

Arguments

:: MonadThrow m

=> FileType

determines for which file type this configuration is

-> PartialHeaderConfig

source PartialHeaderConfig

-> m HeaderConfig

full HeaderConfig

Makes full HeaderConfig from provided PartialHeaderConfig (if valid).