| Copyright | (c) 2019-2020 Vaclav Svejcar |
|---|---|
| License | BSD-3-Clause |
| Maintainer | vaclav.svejcar@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Headroom.Configuration
Description
This module provides logic for working with the cofiguration data types. Headroom uses the partial options monoid pattern for the configuration.
Synopsis
- loadConfiguration :: MonadIO m => FilePath -> m PtConfiguration
- parseConfiguration :: MonadThrow m => ByteString -> m PtConfiguration
- makeConfiguration :: MonadThrow m => PtConfiguration -> m CtConfiguration
- makeHeadersConfig :: MonadThrow m => PtHeadersConfig -> m CtHeadersConfig
- makeHeaderConfig :: MonadThrow m => FileType -> PtHeaderConfig -> m CtHeaderConfig
Loading & Parsing Configuration
Arguments
| :: MonadIO m | |
| => FilePath | path to YAML configuration file |
| -> m PtConfiguration | parsed configuration |
Loads and parses application configuration from given YAML file.
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
Arguments
| :: MonadThrow m | |
| => PtConfiguration | source |
| -> m CtConfiguration | full |
Makes full CtConfiguration from provided PtConfiguration (if valid).
Arguments
| :: MonadThrow m | |
| => PtHeadersConfig | source |
| -> m CtHeadersConfig | full |
Makes full CtHeadersConfig from provided PtHeadersConfig (if valid).
Arguments
| :: MonadThrow m | |
| => FileType | determines for which file type this configuration is |
| -> PtHeaderConfig | source |
| -> m CtHeaderConfig | full |
Makes full CtHeaderConfig from provided PtHeaderConfig (if valid).