Headroom.Config.Global

Global configuration is configuration shared between all Headroom instances and it's located in user's home directory.

Documentation

data GlobalConfig

Data type representing global configuration options.

Constructors

GlobalConfig

Fields

• gcUpdates :: UpdaterConfig

  config for updater

Instances

Eq GlobalConfig

Defined in Headroom.Config.Global

Methods

(==) :: GlobalConfig -> GlobalConfig -> Bool

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

Show GlobalConfig

Defined in Headroom.Config.Global

Methods

showsPrec :: Int -> GlobalConfig -> ShowS

show :: GlobalConfig -> String

showList :: [GlobalConfig] -> ShowS

Generic GlobalConfig

Defined in Headroom.Config.Global

Associated Types

type Rep GlobalConfig :: Type -> Type

Methods

from :: GlobalConfig -> Rep GlobalConfig x

to :: Rep GlobalConfig x -> GlobalConfig

FromJSON GlobalConfig

Defined in Headroom.Config.Global

Methods

parseJSON :: Value -> Parser GlobalConfig

parseJSONList :: Value -> Parser [GlobalConfig]

type Rep GlobalConfig

Defined in Headroom.Config.Global

type Rep GlobalConfig = D1 ('MetaData "GlobalConfig" "Headroom.Config.Global" "headroom-0.4.3.0-CM44re29obUF0crFUQ0ru0" 'False) (C1 ('MetaCons "GlobalConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "gcUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UpdaterConfig)))

data UpdaterConfig

Data type representing updater configuration.

Constructors

UpdaterConfig

Fields

• ucCheckForUpdates :: Bool

  whether to check for updates

• ucUpdateIntervalDays :: Integer

  how ofter check for updates

Instances

Eq UpdaterConfig

Defined in Headroom.Config.Global

Methods

(==) :: UpdaterConfig -> UpdaterConfig -> Bool

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

Show UpdaterConfig

Defined in Headroom.Config.Global

Methods

showsPrec :: Int -> UpdaterConfig -> ShowS

show :: UpdaterConfig -> String

showList :: [UpdaterConfig] -> ShowS

Generic UpdaterConfig

Defined in Headroom.Config.Global

Associated Types

type Rep UpdaterConfig :: Type -> Type

Methods

from :: UpdaterConfig -> Rep UpdaterConfig x

to :: Rep UpdaterConfig x -> UpdaterConfig

FromJSON UpdaterConfig

Defined in Headroom.Config.Global

Methods

parseJSON :: Value -> Parser UpdaterConfig

parseJSONList :: Value -> Parser [UpdaterConfig]

type Rep UpdaterConfig

Defined in Headroom.Config.Global

type Rep UpdaterConfig = D1 ('MetaData "UpdaterConfig" "Headroom.Config.Global" "headroom-0.4.3.0-CM44re29obUF0crFUQ0ru0" 'False) (C1 ('MetaCons "UpdaterConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "ucCheckForUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "ucUpdateIntervalDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))

initGlobalConfigIfNeeded :: HasRIO FileSystem env => RIO env ()

Checks if global configuration YAML file is already present and if not, it creates one with default values.

loadGlobalConfig :: HasRIO FileSystem env => RIO env GlobalConfig

Loads global configuration from YAML file.

parseGlobalConfig :: MonadThrow m => ByteString -> m GlobalConfig

Parses global configuration YAML file.

globalConfigPath :: HasRIO FileSystem env => RIO env FilePath

Path to global configuration YAML file in user's directory.