Modulehorizon-config-shell-0.12.0GHC2024

Horizon.Config.Index

The package indices a run reads at a set's index state, and the check that each has reached it. Hackage's index is append-only and stamps every entry with its publication time, so a copy holds everything published until a state when it holds an entry published after it, or was brought up to date at or after it. One that does neither may not, and the set it renders would depend on when the machine last ran cabal update.

6 values

Packagehorizon-config-shell-0.12.0
Exports6
LanguageGHC2024
LicenceBSD-3-Clause
SourceIndex.hs

valuelocalHackageIndexDir :: IO (Path Abs Dir)

The directory holding the Hackage index cabal2nix reads: hackage-db's own choice (CABAL_DIR, else ~/.cabal, else the XDG cache), so the index checked is the index read.

valueindexIn :: Path Abs Dir -> IO (Maybe (Path Abs File))

The index cabal keeps in a repository's directory: 01-index.tar, else the legacy 00-index.tar, the order hackage-db reads them in.

valuenewestEntry :: Path Abs File -> IO (Either Text (Maybe UTCTime))

The publication time of an index's newest entry, Nothing for an empty index, or why it cannot be read as a tar archive.

valuelastUpdated :: Path Abs Dir -> Path Abs File -> IO UTCTime

When the copy of an index kept in a directory was last brought up to date: cabal update rewrites the repository's timestamp.json whenever the index moves, so its modification time, else the index file's.

valueindexReaches

:: IndexState
-> Text
-> Path Abs Dir
-> IO (Either ConfigError (Path Abs File))

Whether the index a config names, kept in a directory, has reached an index state, giving the file read; the refusal names the file, its newest entry and when it was last updated.

valuehackageIndex

The local Hackage index, read once for every Hackage pin a run renders: as Hackage stood at the index state, once the copy has reached it, else as the copy stands.