Headroom.Types

Module containing most of the data types used by the application.

Error Data Types

data HeadroomError

Top-level of the Headroom exception hierarchy.

Constructors

forall e.Exception e => HeadroomError e

Instances

Show HeadroomError

Defined in Headroom.Types

Methods

showsPrec :: Int -> HeadroomError -> ShowS

show :: HeadroomError -> String

showList :: [HeadroomError] -> ShowS

Exception HeadroomError

Defined in Headroom.Types

Methods

toException :: HeadroomError -> SomeException

fromException :: SomeException -> Maybe HeadroomError

displayException :: HeadroomError -> String

Helper Functions

fromHeadroomError

Arguments

:: Exception e

=> SomeException

exception to unwrap

-> Maybe e

unwrapped exception

Unwraps given exception from HeadroomError.

toHeadroomError

Arguments

:: Exception e

=> e

exception to wrap

-> SomeException

wrapped exception

Wraps given exception into HeadroomError.

Other Data Types

newtype CurrentYear

Wraps the value of current year.

Constructors

CurrentYear

Fields

• unCurrentYear :: Integer

  value of current year

Instances

Eq CurrentYear

Defined in Headroom.Types

Methods

(==) :: CurrentYear -> CurrentYear -> Bool

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

Show CurrentYear

Defined in Headroom.Types

Methods

showsPrec :: Int -> CurrentYear -> ShowS

show :: CurrentYear -> String

showList :: [CurrentYear] -> ShowS

Has CurrentYear ConfiguredEnv

Defined in Headroom.PostProcess

Methods

getter :: ConfiguredEnv -> CurrentYear

modifier :: (CurrentYear -> CurrentYear) -> ConfiguredEnv -> ConfiguredEnv

hasLens :: Lens' ConfiguredEnv CurrentYear

viewL :: MonadReader ConfiguredEnv m => m CurrentYear

data LicenseType

Supported type of open source license.

Constructors

Apache2

support for Apache-2.0 license

BSD3

support for BSD-3-Clause license

GPL2

support for GNU GPL2 license

GPL3

support for GNU GPL3 license

MIT

support for MIT license

MPL2

support for MPL2 license

Instances

Bounded LicenseType

Defined in Headroom.Types

Methods

minBound :: LicenseType

maxBound :: LicenseType

Enum LicenseType

Defined in Headroom.Types

Methods

succ :: LicenseType -> LicenseType

pred :: LicenseType -> LicenseType

toEnum :: Int -> LicenseType

fromEnum :: LicenseType -> Int

enumFrom :: LicenseType -> [LicenseType]

enumFromThen :: LicenseType -> LicenseType -> [LicenseType]

enumFromTo :: LicenseType -> LicenseType -> [LicenseType]

enumFromThenTo :: LicenseType -> LicenseType -> LicenseType -> [LicenseType]

Eq LicenseType

Defined in Headroom.Types

Methods

(==) :: LicenseType -> LicenseType -> Bool

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

Ord LicenseType

Defined in Headroom.Types

Methods

compare :: LicenseType -> LicenseType -> Ordering

(<) :: LicenseType -> LicenseType -> Bool

(<=) :: LicenseType -> LicenseType -> Bool

(>) :: LicenseType -> LicenseType -> Bool

(>=) :: LicenseType -> LicenseType -> Bool

max :: LicenseType -> LicenseType -> LicenseType

min :: LicenseType -> LicenseType -> LicenseType

Show LicenseType

Defined in Headroom.Types

Methods

showsPrec :: Int -> LicenseType -> ShowS

show :: LicenseType -> String

showList :: [LicenseType] -> ShowS

FromJSON LicenseType

Defined in Headroom.Types

Methods

parseJSON :: Value -> Parser LicenseType

parseJSONList :: Value -> Parser [LicenseType]

EnumExtra LicenseType

Defined in Headroom.Types

Methods

allValues :: [LicenseType]

allValuesToText :: Text

enumToText :: LicenseType -> Text

textToEnum :: Text -> Maybe LicenseType