-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Shared data types between various Stackage packages
--   
--   For more information, see
--   <a>https://www.stackage.org/package/stackage-types</a>
@package stackage-types
@version 1.2.0


-- | 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) -> Map Text (Set Text) -> BuildPlan
[bpSystemInfo] :: BuildPlan -> SystemInfo
[bpTools] :: BuildPlan -> Vector (PackageName, Version)
[bpPackages] :: BuildPlan -> Map PackageName PackagePlan
[bpGithubUsers] :: BuildPlan -> Map Text (Set Text)
[bpBuildToolOverrides] :: 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 -> 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

-- | Don't even bother building this library, useful when dealing with
--   OS-specific packages. See:
--   <a>https://github.com/fpco/stackage-curator/issues/3</a>
[pcSkipBuild] :: 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:
--   
--   <ul>
--   <li>Package dependencies</li>
--   <li>Build tool dependencies</li>
--   <li>Provided executables</li>
--   </ul>
--   
--   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 GHC.Classes.Eq Stackage.Types.BuildPlan
instance GHC.Show.Show Stackage.Types.BuildPlan
instance GHC.Classes.Eq Stackage.Types.PackagePlan
instance GHC.Show.Show Stackage.Types.PackagePlan
instance GHC.Classes.Eq Stackage.Types.SimpleDesc
instance GHC.Show.Show Stackage.Types.SimpleDesc
instance GHC.Classes.Eq Stackage.Types.DepInfo
instance GHC.Show.Show Stackage.Types.DepInfo
instance GHC.Enum.Bounded Stackage.Types.Component
instance GHC.Enum.Enum Stackage.Types.Component
instance GHC.Classes.Ord Stackage.Types.Component
instance GHC.Classes.Eq Stackage.Types.Component
instance GHC.Read.Read Stackage.Types.Component
instance GHC.Show.Show Stackage.Types.Component
instance GHC.Classes.Ord Stackage.Types.SystemInfo
instance GHC.Classes.Eq Stackage.Types.SystemInfo
instance GHC.Show.Show Stackage.Types.SystemInfo
instance Data.String.IsString Stackage.Types.ExeName
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.ExeName
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.ExeName
instance Data.Hashable.Class.Hashable Stackage.Types.ExeName
instance GHC.Classes.Ord Stackage.Types.ExeName
instance GHC.Classes.Eq Stackage.Types.ExeName
instance GHC.Show.Show Stackage.Types.ExeName
instance GHC.Classes.Eq Stackage.Types.PackageConstraints
instance GHC.Show.Show Stackage.Types.PackageConstraints
instance Data.String.IsString Stackage.Types.Maintainer
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.Maintainer
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.Maintainer
instance Data.Hashable.Class.Hashable Stackage.Types.Maintainer
instance GHC.Classes.Ord Stackage.Types.Maintainer
instance GHC.Classes.Eq Stackage.Types.Maintainer
instance GHC.Show.Show Stackage.Types.Maintainer
instance GHC.Enum.Enum Stackage.Types.TestState
instance GHC.Enum.Bounded Stackage.Types.TestState
instance GHC.Classes.Ord Stackage.Types.TestState
instance GHC.Classes.Eq Stackage.Types.TestState
instance GHC.Show.Show Stackage.Types.TestState
instance GHC.Show.Show Stackage.Types.ParseFailedException
instance GHC.Classes.Ord Stackage.Types.SnapshotType
instance GHC.Classes.Eq Stackage.Types.SnapshotType
instance GHC.Read.Read Stackage.Types.SnapshotType
instance GHC.Show.Show Stackage.Types.SnapshotType
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.SnapshotType
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.SnapshotType
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.PackageDocs
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.PackageDocs
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.BuildPlan
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.BuildPlan
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.PackagePlan
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.PackagePlan
instance GHC.Exception.Exception Stackage.Types.ParseFailedException
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.PackageConstraints
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.PackageConstraints
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.TestState
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.TestState
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.SystemInfo
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.SystemInfo
instance GHC.Base.Monoid Stackage.Types.SimpleDesc
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.SimpleDesc
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.SimpleDesc
instance Data.Semigroup.Semigroup Stackage.Types.DepInfo
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.DepInfo
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.DepInfo
instance Data.Aeson.Types.ToJSON.ToJSON Stackage.Types.Component
instance Data.Aeson.Types.FromJSON.FromJSON Stackage.Types.Component