Headroom.Configuration.Compat

Description

This module contains functions and data types used for checking compatibility of user's YAML configuration with current version of Headroom.

Synopsis

Documentation

Exception specific to the Headroom.Configuration.Compat module.

Constructors

CannotParseVersion	cannot parse version info from given YAML configuration
NewerVersionDetected Version	configuration has newer version than Headroom
UnsupportedVersion [Version] Version	given YAML configuration is not compatible

Instances details

Eq VersionError Source #
Instance details Defined in Headroom.Configuration.Compat Methods (==) :: VersionError -> VersionError -> Bool # (/=) :: VersionError -> VersionError -> Bool #
Show VersionError Source #
Instance details Defined in Headroom.Configuration.Compat Methods showsPrec :: Int -> VersionError -> ShowS # show :: VersionError -> String # showList :: [VersionError] -> ShowS #
Exception VersionError Source #
Instance details Defined in Headroom.Configuration.Compat Methods toException :: VersionError -> SomeException # fromException :: SomeException -> Maybe VersionError # displayException :: VersionError -> String #

Arguments

:: MonadThrow m
=> [Version]	list of versions with breaking changes in configuration
-> Version	current Headroom version
-> ByteString	raw, not yet parsed YAML configuration
-> m Version	detected compatible version or error

Checks whether the given not yet parsed YAML configuration is compatible, using list of versions that caused breaking changes into configuration.