Copyright	(c) 2019-2022 Vaclav Svejcar
License	BSD-3-Clause
Maintainer	vaclav.svejcar@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Headroom.Updater

Contents

Error Data Types

Description

Update Manager (Updater) is responsible for fetching data about latest version of Headroom and informing user about available updates. In future versions, it might be capable to update Headroom binaries automatically.

Synopsis

checkUpdates :: (HasRIO KVStore env, HasRIO Network env) => UpdaterConfig -> RIO env (Maybe Version)
fetchLatestVersion :: HasRIO Network env => RIO env Version
parseLatestVersion :: MonadThrow m => Value -> m Version
data UpdaterError = CannotDetectVersion Text

Documentation

checkUpdates :: (HasRIO KVStore env, HasRIO Network env) => UpdaterConfig -> RIO env (Maybe Version) Source #

Check whether newer version is available (if enabled by configuration).

fetchLatestVersion :: HasRIO Network env => RIO env Version Source #

Fetches and parses latest version from update server.

parseLatestVersion Source #

Arguments

:: MonadThrow m
=> Value	raw JSON response from GitHub
-> m Version	parsed version

Parses latest version number from GitHub API response.

Error Data Types

data UpdaterError Source #

Error during processing updates.

Constructors

CannotDetectVersion Text

Instances

Instances details

Eq UpdaterError Source #
Instance details Defined in Headroom.Updater Methods (==) :: UpdaterError -> UpdaterError -> Bool # (/=) :: UpdaterError -> UpdaterError -> Bool #
Show UpdaterError Source #
Instance details Defined in Headroom.Updater Methods showsPrec :: Int -> UpdaterError -> ShowS # show :: UpdaterError -> String # showList :: [UpdaterError] -> ShowS #
Exception UpdaterError Source #
Instance details Defined in Headroom.Updater Methods toException :: UpdaterError -> SomeException # fromException :: SomeException -> Maybe UpdaterError # displayException :: UpdaterError -> String #