Staversion.Internal.BuildPlan

This is an internal module. End-users should not use it.

Entry APIs

class HasVersions t where

Types that have mapping between PackageName and Version.

Minimal complete definition

packageVersion

Methods

packageVersion :: t -> PackageName -> Maybe Version

Instances

HasVersions BuildPlan

Methods

packageVersion :: BuildPlan -> PackageName -> Maybe Version

HasVersions BuildPlanMap

Methods

packageVersion :: BuildPlanMap -> PackageName -> Maybe Version

data BuildPlan

A BuildPlanMap associated with its PackageSource.

Instances

HasVersions BuildPlan

Methods

packageVersion :: BuildPlan -> PackageName -> Maybe Version

buildPlanSource :: BuildPlan -> PackageSource

data BuildPlanManager

Stateful manager for BuildPlans.

newBuildPlanManager

Arguments

:: FilePath

path to the directory where build plans are hold.

-> Logger

-> Bool

If True, it queries the Internet for build plans. Otherwise, it won't.

-> IO BuildPlanManager

loadBuildPlan

Arguments

:: BuildPlanManager

-> [PackageName]

package names whose versions the user is interested in.

-> PackageSource

-> IO (Either ErrorMsg BuildPlan)

the second result is the real (disambiguated) PackageSource.

Low-level APIs

data BuildPlanMap

A data structure that keeps a map between package names and their versions.

Instances

Monoid BuildPlanMap

Methods

mempty :: BuildPlanMap

mappend :: BuildPlanMap -> BuildPlanMap -> BuildPlanMap

mconcat :: [BuildPlanMap] -> BuildPlanMap

FromJSON BuildPlanMap

Methods

parseJSON :: Value -> Parser BuildPlanMap

parseJSONList :: Value -> Parser [BuildPlanMap]

HasVersions BuildPlanMap

Methods

packageVersion :: BuildPlanMap -> PackageName -> Maybe Version

loadBuildPlanMapYAML :: FilePath -> IO (Either ErrorMsg BuildPlanMap)

Load a BuildPlanMap from a file.

For tests

_setLTSDisambiguator

Arguments

:: BuildPlanManager

-> Word

disambiguated LTS major version

-> Word

disambiguated LTS minor version

-> IO ()