Headroom.Configuration

This module provides logic for working with the cofiguration data types. Headroom uses the partial options monoid pattern for the configuration.

Loading & Parsing Configuration

loadConfiguration

Arguments

:: MonadIO m

=> FilePath

path to YAML configuration file

-> m PtConfiguration

parsed configuration

Loads and parses application configuration from given YAML file.

parseConfiguration

Arguments

:: MonadThrow m

=> ByteString

raw input to parse

-> m PtConfiguration

parsed application configuration

Parses application configuration from given raw input in YAML format.

Processing Partial Configuration

makeConfiguration

Arguments

:: MonadThrow m

=> PtConfiguration

source PtConfiguration

-> m CtConfiguration

full CtConfiguration

Makes full CtConfiguration from provided PtConfiguration (if valid).

makeHeadersConfig

Arguments

:: MonadThrow m

=> PtHeadersConfig

source PtHeadersConfig

-> m CtHeadersConfig

full CtHeadersConfig

Makes full CtHeadersConfig from provided PtHeadersConfig (if valid).

makeHeaderConfig

Arguments

:: MonadThrow m

=> FileType

determines for which file type this configuration is

-> PtHeaderConfig

source PtHeaderConfig

-> m CtHeaderConfig

full CtHeaderConfig

Makes full CtHeaderConfig from provided PtHeaderConfig (if valid).