Safe Haskell	None
Language	Haskell2010

Stackage.Types

Contents

Types
Helper functions

Description

Shared types for various stackage packages.

Synopsis

Types

data SnapshotType Source #

Constructors

STNightly
STNightly2 !Day
STLTS !Int !Int	major, minor

Instances

Eq SnapshotType Source #
Methods (==) :: SnapshotType -> SnapshotType -> Bool # (/=) :: SnapshotType -> SnapshotType -> Bool #
Ord SnapshotType Source #
Methods compare :: SnapshotType -> SnapshotType -> Ordering # (<) :: SnapshotType -> SnapshotType -> Bool # (<=) :: SnapshotType -> SnapshotType -> Bool # (>) :: SnapshotType -> SnapshotType -> Bool # (>=) :: SnapshotType -> SnapshotType -> Bool # max :: SnapshotType -> SnapshotType -> SnapshotType # min :: SnapshotType -> SnapshotType -> SnapshotType #
Read SnapshotType Source #
Methods readsPrec :: Int -> ReadS SnapshotType # readList :: ReadS [SnapshotType] # readPrec :: ReadPrec SnapshotType # readListPrec :: ReadPrec [SnapshotType] #
Show SnapshotType Source #
Methods showsPrec :: Int -> SnapshotType -> ShowS # show :: SnapshotType -> String # showList :: [SnapshotType] -> ShowS #
ToJSON SnapshotType Source #
Methods toJSON :: SnapshotType -> Value # toEncoding :: SnapshotType -> Encoding # toJSONList :: [SnapshotType] -> Value # toEncodingList :: [SnapshotType] -> Encoding #
FromJSON SnapshotType Source #
Methods parseJSON :: Value -> Parser SnapshotType # parseJSONList :: Value -> Parser [SnapshotType] #

type DocMap = Map Text PackageDocs Source #

Package name is key

data PackageDocs Source #

Constructors

PackageDocs
Fields pdVersion :: Text pdModules :: Map Text [Text] module name, path

Instances

ToJSON PackageDocs Source #
Methods toJSON :: PackageDocs -> Value # toEncoding :: PackageDocs -> Encoding # toJSONList :: [PackageDocs] -> Value # toEncodingList :: [PackageDocs] -> Encoding #
FromJSON PackageDocs Source #
Methods parseJSON :: Value -> Parser PackageDocs # parseJSONList :: Value -> Parser [PackageDocs] #

data BuildPlan Source #

Constructors

BuildPlan
Fields bpSystemInfo :: SystemInfo bpTools :: Vector (PackageName, Version) bpPackages :: Map PackageName PackagePlan bpGithubUsers :: Map Text (Set Text) bpBuildToolOverrides :: Map Text (Set Text) bpAllCabalHashesCommit :: Maybe Text

Instances

Eq BuildPlan Source #
Methods (==) :: BuildPlan -> BuildPlan -> Bool # (/=) :: BuildPlan -> BuildPlan -> Bool #
Show BuildPlan Source #
Methods showsPrec :: Int -> BuildPlan -> ShowS # show :: BuildPlan -> String # showList :: [BuildPlan] -> ShowS #
ToJSON BuildPlan Source #
Methods toJSON :: BuildPlan -> Value # toEncoding :: BuildPlan -> Encoding # toJSONList :: [BuildPlan] -> Value # toEncodingList :: [BuildPlan] -> Encoding #
FromJSON BuildPlan Source #
Methods parseJSON :: Value -> Parser BuildPlan # parseJSONList :: Value -> Parser [BuildPlan] #

data PackagePlan Source #

Constructors

PackagePlan
Fields ppVersion :: Version ppCabalFileInfo :: Maybe CabalFileInfo ppGithubPings :: Set Text ppUsers :: Set PackageName ppConstraints :: PackageConstraints ppDesc :: SimpleDesc ppSourceUrl :: Maybe Text

Instances

Eq PackagePlan Source #
Methods (==) :: PackagePlan -> PackagePlan -> Bool # (/=) :: PackagePlan -> PackagePlan -> Bool #
Show PackagePlan Source #
Methods showsPrec :: Int -> PackagePlan -> ShowS # show :: PackagePlan -> String # showList :: [PackagePlan] -> ShowS #
ToJSON PackagePlan Source #
Methods toJSON :: PackagePlan -> Value # toEncoding :: PackagePlan -> Encoding # toJSONList :: [PackagePlan] -> Value # toEncodingList :: [PackagePlan] -> Encoding #
FromJSON PackagePlan Source #
Methods parseJSON :: Value -> Parser PackagePlan # parseJSONList :: Value -> Parser [PackagePlan] #

data PackageConstraints Source #

Constructors

PackageConstraints

Fields

pcVersionRange :: VersionRange
pcMaintainer :: Maybe Maintainer
pcTests :: TestState
pcBenches :: TestState
pcHaddocks :: TestState
pcFlagOverrides :: Map FlagName Bool
pcConfigureArgs :: Vector Text
pcEnableLibProfile :: Bool
pcSkipBuild :: Bool
Don't even bother building this library, useful when dealing with OS-specific packages. See: https://github.com/fpco/stackage-curator/issues/3

Instances

Eq PackageConstraints Source #
Methods (==) :: PackageConstraints -> PackageConstraints -> Bool # (/=) :: PackageConstraints -> PackageConstraints -> Bool #
Show PackageConstraints Source #
Methods showsPrec :: Int -> PackageConstraints -> ShowS # show :: PackageConstraints -> String # showList :: [PackageConstraints] -> ShowS #
ToJSON PackageConstraints Source #
Methods toJSON :: PackageConstraints -> Value # toEncoding :: PackageConstraints -> Encoding # toJSONList :: [PackageConstraints] -> Value # toEncodingList :: [PackageConstraints] -> Encoding #
FromJSON PackageConstraints Source #
Methods parseJSON :: Value -> Parser PackageConstraints # parseJSONList :: Value -> Parser [PackageConstraints] #

data ParseFailedException Source #

Constructors

ParseFailedException TypeRep Text

Instances

Show ParseFailedException Source #
Methods showsPrec :: Int -> ParseFailedException -> ShowS # show :: ParseFailedException -> String # showList :: [ParseFailedException] -> ShowS #
Exception ParseFailedException Source #
Methods toException :: ParseFailedException -> SomeException # fromException :: SomeException -> Maybe ParseFailedException # displayException :: ParseFailedException -> String #

data TestState Source #

Constructors

ExpectSuccess
ExpectFailure
Don'tBuild	when the test suite will pull in things we don't want

Instances

Bounded TestState Source #
Methods minBound :: TestState # maxBound :: TestState #
Enum TestState Source #
Methods succ :: TestState -> TestState # pred :: TestState -> TestState # toEnum :: Int -> TestState # fromEnum :: TestState -> Int # enumFrom :: TestState -> [TestState] # enumFromThen :: TestState -> TestState -> [TestState] # enumFromTo :: TestState -> TestState -> [TestState] # enumFromThenTo :: TestState -> TestState -> TestState -> [TestState] #
Eq TestState Source #
Methods (==) :: TestState -> TestState -> Bool # (/=) :: TestState -> TestState -> Bool #
Ord TestState Source #
Methods compare :: TestState -> TestState -> Ordering # (<) :: TestState -> TestState -> Bool # (<=) :: TestState -> TestState -> Bool # (>) :: TestState -> TestState -> Bool # (>=) :: TestState -> TestState -> Bool # max :: TestState -> TestState -> TestState # min :: TestState -> TestState -> TestState #
Show TestState Source #
Methods showsPrec :: Int -> TestState -> ShowS # show :: TestState -> String # showList :: [TestState] -> ShowS #
ToJSON TestState Source #
Methods toJSON :: TestState -> Value # toEncoding :: TestState -> Encoding # toJSONList :: [TestState] -> Value # toEncodingList :: [TestState] -> Encoding #
FromJSON TestState Source #
Methods parseJSON :: Value -> Parser TestState # parseJSONList :: Value -> Parser [TestState] #

data SystemInfo Source #

Constructors

SystemInfo
Fields siGhcVersion :: Version siOS :: OS siArch :: Arch siCorePackages :: Map PackageName Version siCoreExecutables :: Set ExeName

Instances

Eq SystemInfo Source #
Methods (==) :: SystemInfo -> SystemInfo -> Bool # (/=) :: SystemInfo -> SystemInfo -> Bool #
Ord SystemInfo Source #
Methods compare :: SystemInfo -> SystemInfo -> Ordering # (<) :: SystemInfo -> SystemInfo -> Bool # (<=) :: SystemInfo -> SystemInfo -> Bool # (>) :: SystemInfo -> SystemInfo -> Bool # (>=) :: SystemInfo -> SystemInfo -> Bool # max :: SystemInfo -> SystemInfo -> SystemInfo # min :: SystemInfo -> SystemInfo -> SystemInfo #
Show SystemInfo Source #
Methods showsPrec :: Int -> SystemInfo -> ShowS # show :: SystemInfo -> String # showList :: [SystemInfo] -> ShowS #
ToJSON SystemInfo Source #
Methods toJSON :: SystemInfo -> Value # toEncoding :: SystemInfo -> Encoding # toJSONList :: [SystemInfo] -> Value # toEncodingList :: [SystemInfo] -> Encoding #
FromJSON SystemInfo Source #
Methods parseJSON :: Value -> Parser SystemInfo # parseJSONList :: Value -> Parser [SystemInfo] #

newtype Maintainer Source #

Constructors

Maintainer
Fields unMaintainer :: Text

Instances

Eq Maintainer Source #
Methods (==) :: Maintainer -> Maintainer -> Bool # (/=) :: Maintainer -> Maintainer -> Bool #
Ord Maintainer Source #
Methods compare :: Maintainer -> Maintainer -> Ordering # (<) :: Maintainer -> Maintainer -> Bool # (<=) :: Maintainer -> Maintainer -> Bool # (>) :: Maintainer -> Maintainer -> Bool # (>=) :: Maintainer -> Maintainer -> Bool # max :: Maintainer -> Maintainer -> Maintainer # min :: Maintainer -> Maintainer -> Maintainer #
Show Maintainer Source #
Methods showsPrec :: Int -> Maintainer -> ShowS # show :: Maintainer -> String # showList :: [Maintainer] -> ShowS #
IsString Maintainer Source #
Methods fromString :: String -> Maintainer #
Hashable Maintainer Source #
Methods hashWithSalt :: Int -> Maintainer -> Int # hash :: Maintainer -> Int #
ToJSON Maintainer Source #
Methods toJSON :: Maintainer -> Value # toEncoding :: Maintainer -> Encoding # toJSONList :: [Maintainer] -> Value # toEncodingList :: [Maintainer] -> Encoding #
FromJSON Maintainer Source #
Methods parseJSON :: Value -> Parser Maintainer # parseJSONList :: Value -> Parser [Maintainer] #

newtype ExeName Source #

Name of an executable.

Constructors

ExeName
Fields unExeName :: Text

Instances

Eq ExeName Source #
Methods (==) :: ExeName -> ExeName -> Bool # (/=) :: ExeName -> ExeName -> Bool #
Ord ExeName Source #
Methods compare :: ExeName -> ExeName -> Ordering # (<) :: ExeName -> ExeName -> Bool # (<=) :: ExeName -> ExeName -> Bool # (>) :: ExeName -> ExeName -> Bool # (>=) :: ExeName -> ExeName -> Bool # max :: ExeName -> ExeName -> ExeName # min :: ExeName -> ExeName -> ExeName #
Show ExeName Source #
Methods showsPrec :: Int -> ExeName -> ShowS # show :: ExeName -> String # showList :: [ExeName] -> ShowS #
IsString ExeName Source #
Methods fromString :: String -> ExeName #
Hashable ExeName Source #
Methods hashWithSalt :: Int -> ExeName -> Int # hash :: ExeName -> Int #
ToJSON ExeName Source #
Methods toJSON :: ExeName -> Value # toEncoding :: ExeName -> Encoding # toJSONList :: [ExeName] -> Value # toEncodingList :: [ExeName] -> Encoding #
FromJSON ExeName Source #
Methods parseJSON :: Value -> Parser ExeName # parseJSONList :: Value -> Parser [ExeName] #

data SimpleDesc Source #

A simplified package description that tracks:

Package dependencies
Build tool dependencies
Provided executables

It has fully resolved all conditionals

Constructors

SimpleDesc
Fields sdPackages :: Map PackageName DepInfo sdTools :: Map ExeName DepInfo sdProvidedExes :: Set ExeName sdModules :: Set Text modules exported by the library sdCabalVersion :: Option (Max Version) minimum acceptable Cabal version

Instances

Eq SimpleDesc Source #
Methods (==) :: SimpleDesc -> SimpleDesc -> Bool # (/=) :: SimpleDesc -> SimpleDesc -> Bool #
Show SimpleDesc Source #
Methods showsPrec :: Int -> SimpleDesc -> ShowS # show :: SimpleDesc -> String # showList :: [SimpleDesc] -> ShowS #
Monoid SimpleDesc Source #
Methods mempty :: SimpleDesc # mappend :: SimpleDesc -> SimpleDesc -> SimpleDesc # mconcat :: [SimpleDesc] -> SimpleDesc #
ToJSON SimpleDesc Source #
Methods toJSON :: SimpleDesc -> Value # toEncoding :: SimpleDesc -> Encoding # toJSONList :: [SimpleDesc] -> Value # toEncodingList :: [SimpleDesc] -> Encoding #
FromJSON SimpleDesc Source #
Methods parseJSON :: Value -> Parser SimpleDesc # parseJSONList :: Value -> Parser [SimpleDesc] #

data DepInfo Source #

Constructors

DepInfo
Fields diComponents :: Set Component diRange :: VersionRange

Instances

Eq DepInfo Source #
Methods (==) :: DepInfo -> DepInfo -> Bool # (/=) :: DepInfo -> DepInfo -> Bool #
Show DepInfo Source #
Methods showsPrec :: Int -> DepInfo -> ShowS # show :: DepInfo -> String # showList :: [DepInfo] -> ShowS #
Semigroup DepInfo Source #
Methods (<>) :: DepInfo -> DepInfo -> DepInfo # sconcat :: NonEmpty DepInfo -> DepInfo # stimes :: Integral b => b -> DepInfo -> DepInfo #
ToJSON DepInfo Source #
Methods toJSON :: DepInfo -> Value # toEncoding :: DepInfo -> Encoding # toJSONList :: [DepInfo] -> Value # toEncodingList :: [DepInfo] -> Encoding #
FromJSON DepInfo Source #
Methods parseJSON :: Value -> Parser DepInfo # parseJSONList :: Value -> Parser [DepInfo] #

data Component Source #

Constructors

CompLibrary
CompExecutable
CompTestSuite
CompBenchmark

Instances

Bounded Component Source #
Methods minBound :: Component # maxBound :: Component #
Enum Component Source #
Methods succ :: Component -> Component # pred :: Component -> Component # toEnum :: Int -> Component # fromEnum :: Component -> Int # enumFrom :: Component -> [Component] # enumFromThen :: Component -> Component -> [Component] # enumFromTo :: Component -> Component -> [Component] # enumFromThenTo :: Component -> Component -> Component -> [Component] #
Eq Component Source #
Methods (==) :: Component -> Component -> Bool # (/=) :: Component -> Component -> Bool #
Ord Component Source #
Methods compare :: Component -> Component -> Ordering # (<) :: Component -> Component -> Bool # (<=) :: Component -> Component -> Bool # (>) :: Component -> Component -> Bool # (>=) :: Component -> Component -> Bool # max :: Component -> Component -> Component # min :: Component -> Component -> Component #
Read Component Source #
Methods readsPrec :: Int -> ReadS Component # readList :: ReadS [Component] # readPrec :: ReadPrec Component # readListPrec :: ReadPrec [Component] #
Show Component Source #
Methods showsPrec :: Int -> Component -> ShowS # show :: Component -> String # showList :: [Component] -> ShowS #
ToJSON Component Source #
Methods toJSON :: Component -> Value # toEncoding :: Component -> Encoding # toJSONList :: [Component] -> Value # toEncodingList :: [Component] -> Encoding #
FromJSON Component Source #
Methods parseJSON :: Value -> Parser Component # parseJSONList :: Value -> Parser [Component] #

data CabalFileInfo Source #

Information on the contents of a cabal file

Constructors

CabalFileInfo
Fields cfiSize :: !Int File size in bytes cfiHashes :: !(Map Text Text) Various hashes of the file contents

Instances

Eq CabalFileInfo Source #
Methods (==) :: CabalFileInfo -> CabalFileInfo -> Bool # (/=) :: CabalFileInfo -> CabalFileInfo -> Bool #
Show CabalFileInfo Source #
Methods showsPrec :: Int -> CabalFileInfo -> ShowS # show :: CabalFileInfo -> String # showList :: [CabalFileInfo] -> ShowS #
Generic CabalFileInfo Source #
Associated Types type Rep CabalFileInfo :: * -> * # Methods from :: CabalFileInfo -> Rep CabalFileInfo x # to :: Rep CabalFileInfo x -> CabalFileInfo #
ToJSON CabalFileInfo Source #
Methods toJSON :: CabalFileInfo -> Value # toEncoding :: CabalFileInfo -> Encoding # toJSONList :: [CabalFileInfo] -> Value # toEncodingList :: [CabalFileInfo] -> Encoding #
FromJSON CabalFileInfo Source #
Methods parseJSON :: Value -> Parser CabalFileInfo # parseJSONList :: Value -> Parser [CabalFileInfo] #
Store CabalFileInfo Source #
Methods size :: Size CabalFileInfo # poke :: CabalFileInfo -> Poke () # peek :: Peek CabalFileInfo #
type Rep CabalFileInfo Source #
type Rep CabalFileInfo = D1 (MetaData "CabalFileInfo" "Stackage.Types" "stackage-curator-0.14.4.1-4nftsHNaDBbGG7piIyauP" False) (C1 (MetaCons "CabalFileInfo" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "cfiSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "cfiHashes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map Text Text)))))

Helper functions

display :: Text a => a -> Text Source #

simpleParse :: (MonadThrow m, Text a, Typeable a) => Text -> m a Source #

unPackageName :: PackageName -> Text Source #

mkPackageName :: Text -> PackageName Source #

unFlagName :: FlagName -> Text Source #

mkFlagName :: Text -> FlagName Source #

intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange Source #

compToText :: Component -> Text Source #