headroom-0.4.3.0: License Header Manager
Copyright(c) 2019-2022 Vaclav Svejcar
LicenseBSD-3-Clause
Maintainervaclav.svejcar@gmail.com
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Headroom.Config.Global

Description

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

Synopsis

Documentation

data GlobalConfig Source #

Data type representing global configuration options.

Constructors

GlobalConfig 

Fields

Instances

Instances details
Eq GlobalConfig Source # 
Instance details

Defined in Headroom.Config.Global

Methods

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

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

Show GlobalConfig Source # 
Instance details

Defined in Headroom.Config.Global

Methods

showsPrec :: Int -> GlobalConfig -> ShowS #

show :: GlobalConfig -> String #

showList :: [GlobalConfig] -> ShowS #

Generic GlobalConfig Source # 
Instance details

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 Source # 
Instance details

Defined in Headroom.Config.Global

Methods

parseJSON :: Value -> Parser GlobalConfig #

parseJSONList :: Value -> Parser [GlobalConfig] #

type Rep GlobalConfig Source # 
Instance details

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 Source #

Data type representing updater configuration.

Constructors

UpdaterConfig 

Fields

Instances

Instances details
Eq UpdaterConfig Source # 
Instance details

Defined in Headroom.Config.Global

Methods

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

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

Show UpdaterConfig Source # 
Instance details

Defined in Headroom.Config.Global

Methods

showsPrec :: Int -> UpdaterConfig -> ShowS #

show :: UpdaterConfig -> String #

showList :: [UpdaterConfig] -> ShowS #

Generic UpdaterConfig Source # 
Instance details

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 Source # 
Instance details

Defined in Headroom.Config.Global

Methods

parseJSON :: Value -> Parser UpdaterConfig #

parseJSONList :: Value -> Parser [UpdaterConfig] #

type Rep UpdaterConfig Source # 
Instance details

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 () Source #

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 Source #

Loads global configuration from YAML file.

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

Parses global configuration YAML file.

globalConfigPath :: HasRIO FileSystem env => RIO env FilePath Source #

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