Headroom.Configuration.Compat

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

Documentation

data VersionError

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

Eq VersionError

Defined in Headroom.Configuration.Compat

Methods

(==) :: VersionError -> VersionError -> Bool

(/=) :: VersionError -> VersionError -> Bool

Show VersionError

Defined in Headroom.Configuration.Compat

Methods

showsPrec :: Int -> VersionError -> ShowS

show :: VersionError -> String

showList :: [VersionError] -> ShowS

Exception VersionError

Defined in Headroom.Configuration.Compat

Methods

toException :: VersionError -> SomeException

fromException :: SomeException -> Maybe VersionError

displayException :: VersionError -> String

checkCompatibility

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.