-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Shared data types between various Stackage packages
--
@package stackage-types
@version 1.0.1
-- | Shared types for various stackage packages.
module Stackage.Types
data SnapshotType
STNightly :: SnapshotType
STNightly2 :: !Day -> SnapshotType
-- | major, minor
STLTS :: !Int -> !Int -> SnapshotType
-- | Package name is key
type DocMap = Map Text PackageDocs
data PackageDocs
PackageDocs :: Text -> Map Text [Text] -> PackageDocs
pdVersion :: PackageDocs -> Text
-- | module name, path
pdModules :: PackageDocs -> Map Text [Text]
data BuildPlan
BuildPlan :: SystemInfo -> Vector (PackageName, Version) -> Map PackageName PackagePlan -> Map Text (Set Text) -> BuildPlan
bpSystemInfo :: BuildPlan -> SystemInfo
bpTools :: BuildPlan -> Vector (PackageName, Version)
bpPackages :: BuildPlan -> Map PackageName PackagePlan
bpGithubUsers :: BuildPlan -> Map Text (Set Text)
data PackagePlan
PackagePlan :: Version -> Set Text -> Set PackageName -> PackageConstraints -> SimpleDesc -> PackagePlan
ppVersion :: PackagePlan -> Version
ppGithubPings :: PackagePlan -> Set Text
ppUsers :: PackagePlan -> Set PackageName
ppConstraints :: PackagePlan -> PackageConstraints
ppDesc :: PackagePlan -> SimpleDesc
data PackageConstraints
PackageConstraints :: VersionRange -> Maybe Maintainer -> TestState -> TestState -> Bool -> Map FlagName Bool -> Bool -> PackageConstraints
pcVersionRange :: PackageConstraints -> VersionRange
pcMaintainer :: PackageConstraints -> Maybe Maintainer
pcTests :: PackageConstraints -> TestState
pcHaddocks :: PackageConstraints -> TestState
pcBuildBenchmarks :: PackageConstraints -> Bool
pcFlagOverrides :: PackageConstraints -> Map FlagName Bool
pcEnableLibProfile :: PackageConstraints -> Bool
data ParseFailedException
ParseFailedException :: TypeRep -> Text -> ParseFailedException
data TestState
ExpectSuccess :: TestState
ExpectFailure :: TestState
-- | when the test suite will pull in things we don't want
Don'tBuild :: TestState
data SystemInfo
SystemInfo :: Version -> OS -> Arch -> Map PackageName Version -> Set ExeName -> SystemInfo
siGhcVersion :: SystemInfo -> Version
siOS :: SystemInfo -> OS
siArch :: SystemInfo -> Arch
siCorePackages :: SystemInfo -> Map PackageName Version
siCoreExecutables :: SystemInfo -> Set ExeName
newtype Maintainer
Maintainer :: Text -> Maintainer
unMaintainer :: Maintainer -> Text
-- | Name of an executable.
newtype ExeName
ExeName :: Text -> ExeName
unExeName :: ExeName -> Text
-- | A simplified package description that tracks:
--
--
-- - Package dependencies
-- - Build tool dependencies
-- - Provided executables
--
--
-- It has fully resolved all conditionals
data SimpleDesc
SimpleDesc :: Map PackageName DepInfo -> Map ExeName DepInfo -> Set ExeName -> Set Text -> SimpleDesc
sdPackages :: SimpleDesc -> Map PackageName DepInfo
sdTools :: SimpleDesc -> Map ExeName DepInfo
sdProvidedExes :: SimpleDesc -> Set ExeName
-- | modules exported by the library
sdModules :: SimpleDesc -> Set Text
data DepInfo
DepInfo :: Set Component -> VersionRange -> DepInfo
diComponents :: DepInfo -> Set Component
diRange :: DepInfo -> VersionRange
data Component
CompLibrary :: Component
CompExecutable :: Component
CompTestSuite :: Component
CompBenchmark :: Component
display :: Text a => a -> Text
simpleParse :: (MonadThrow m, Text a, Typeable a) => Text -> m a
unPackageName :: PackageName -> Text
mkPackageName :: Text -> PackageName
unFlagName :: FlagName -> Text
mkFlagName :: Text -> FlagName
intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange
instance Typeable ParseFailedException
instance Show SnapshotType
instance Read SnapshotType
instance Eq SnapshotType
instance Ord SnapshotType
instance Show ParseFailedException
instance Show TestState
instance Eq TestState
instance Ord TestState
instance Bounded TestState
instance Enum TestState
instance Show Maintainer
instance Eq Maintainer
instance Ord Maintainer
instance Hashable Maintainer
instance ToJSON Maintainer
instance FromJSON Maintainer
instance IsString Maintainer
instance Show PackageConstraints
instance Eq PackageConstraints
instance Show ExeName
instance Eq ExeName
instance Ord ExeName
instance Hashable ExeName
instance ToJSON ExeName
instance FromJSON ExeName
instance IsString ExeName
instance Show SystemInfo
instance Eq SystemInfo
instance Ord SystemInfo
instance Show Component
instance Read Component
instance Eq Component
instance Ord Component
instance Enum Component
instance Bounded Component
instance Show DepInfo
instance Eq DepInfo
instance Show SimpleDesc
instance Eq SimpleDesc
instance Show PackagePlan
instance Eq PackagePlan
instance Show BuildPlan
instance Eq BuildPlan
instance FromJSON Component
instance ToJSON Component
instance FromJSON DepInfo
instance ToJSON DepInfo
instance Semigroup DepInfo
instance FromJSON SimpleDesc
instance ToJSON SimpleDesc
instance Monoid SimpleDesc
instance FromJSON SystemInfo
instance ToJSON SystemInfo
instance FromJSON TestState
instance ToJSON TestState
instance FromJSON PackageConstraints
instance ToJSON PackageConstraints
instance Exception ParseFailedException
instance FromJSON PackagePlan
instance ToJSON PackagePlan
instance FromJSON BuildPlan
instance ToJSON BuildPlan
instance FromJSON PackageDocs
instance ToJSON PackageDocs
instance FromJSON SnapshotType
instance ToJSON SnapshotType