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

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

data TemplateMeta

Metadata parsed from raw template, specific for selected file type.

Constructors

HaskellTemplateMeta !HaddockFieldOffsets

Instances

Eq TemplateMeta

Defined in Headroom.Types

Methods

(==) :: TemplateMeta -> TemplateMeta -> Bool

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

Show TemplateMeta

Defined in Headroom.Types

Methods

showsPrec :: Int -> TemplateMeta -> ShowS

show :: TemplateMeta -> String

showList :: [TemplateMeta] -> ShowS

data HaddockFieldOffsets

Offsets for selected fields extracted from Haddock module header.

Constructors

HaddockFieldOffsets

Fields

• hfoCopyright :: !(Maybe Int)

  offset for Copyright field

Instances

Eq HaddockFieldOffsets

Defined in Headroom.Types

Methods

(==) :: HaddockFieldOffsets -> HaddockFieldOffsets -> Bool

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

Show HaddockFieldOffsets

Defined in Headroom.Types

Methods

showsPrec :: Int -> HaddockFieldOffsets -> ShowS

show :: HaddockFieldOffsets -> String

showList :: [HaddockFieldOffsets] -> ShowS

Default HaddockFieldOffsets

Defined in Headroom.Types

Methods

def :: HaddockFieldOffsets

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.HeaderFn

Methods

getter :: ConfiguredEnv -> CurrentYear

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

hasLens :: Lens' ConfiguredEnv CurrentYear

viewL :: MonadReader ConfiguredEnv m => m CurrentYear