Safe Haskell	None
Language	Haskell2010

Pantry.Types

Synopsis

data PantryConfig = PantryConfig {
- pcPackageIndex :: !PackageIndexConfig
- pcHpackExecutable :: !HpackExecutable
- pcHpackForce :: !Force
- pcRootDir :: !(Path Abs Dir)
- pcStorage :: !Storage
- pcUpdateRef :: !(MVar Bool)
- pcParsedCabalFilesRawImmutable :: !(IORef (Map RawPackageLocationImmutable GenericPackageDescription))
- pcParsedCabalFilesMutable :: !(IORef (Map (Path Abs Dir) (PrintWarnings -> IO GenericPackageDescription, PackageName, Path Abs File)))
- pcConnectionCount :: !Int
- pcCasaConfig :: !(Maybe (CasaRepoPrefix, Int))
- pcSnapshotLocation :: SnapName -> RawSnapshotLocation
- pcGlobalHintsLocation :: WantedCompiler -> GlobalHintsLocation
}
data PackageIndexConfig = PackageIndexConfig {
- picDownloadPrefix :: !Text
- picHackageSecurityConfig :: !HackageSecurityConfig
}
data HackageSecurityConfig = HackageSecurityConfig {
- hscKeyIds :: ![Text]
- hscKeyThreshold :: !Int
- hscIgnoreExpiry :: !Bool
}
defaultHackageSecurityConfig :: HackageSecurityConfig
data Storage = Storage {
- withStorage_ :: forall env a. HasLogFunc env => ReaderT SqlBackend (RIO env) a -> RIO env a
- withWriteLock_ :: forall env a. HasLogFunc env => RIO env a -> RIO env a
}
class HasPantryConfig env where
- pantryConfigL :: Lens' env PantryConfig
data BlobKey = BlobKey !SHA256 !FileSize
data PackageName
data Version
data PackageIdentifier = PackageIdentifier {
- pkgName :: PackageName
- pkgVersion :: Version
}
newtype Revision = Revision Word
data ModuleName
data CabalFileInfo
- = CFILatest
- | CFIHash !SHA256 !(Maybe FileSize)
- | CFIRevision !Revision
data PrintWarnings
- = YesPrintWarnings
- | NoPrintWarnings
newtype PackageNameP = PackageNameP {
- unPackageNameP :: PackageName
}
newtype VersionP = VersionP {
- unVersionP :: Version
}
newtype ModuleNameP = ModuleNameP {
- unModuleNameP :: ModuleName
}
data PackageIdentifierRevision = PackageIdentifierRevision !PackageName !Version !CabalFileInfo
pirForHash :: PackageIdentifier -> BlobKey -> PackageIdentifierRevision
data FileType
- = FTNormal
- | FTExecutable
data BuildFile
- = BFCabal !SafeFilePath !TreeEntry
- | BFHpack !TreeEntry
newtype FileSize = FileSize Word
data TreeEntry = TreeEntry {
- teBlob :: !BlobKey
- teType :: !FileType
}
data SafeFilePath
unSafeFilePath :: SafeFilePath -> Text
mkSafeFilePath :: Text -> Maybe SafeFilePath
safeFilePathToPath :: MonadThrow m => Path Abs Dir -> SafeFilePath -> m (Path Abs File)
hpackSafeFilePath :: SafeFilePath
newtype TreeKey = TreeKey BlobKey
newtype Tree = TreeMap (Map SafeFilePath TreeEntry)
renderTree :: Tree -> ByteString
parseTree :: ByteString -> Maybe Tree
parseTreeM :: MonadThrow m => (BlobKey, ByteString) -> m (TreeKey, Tree)
data SHA256
data Unresolved a
resolvePaths :: MonadIO m => Maybe (Path Abs Dir) -> Unresolved a -> m a
data Package = Package {
- packageTreeKey :: !TreeKey
- packageTree :: !Tree
- packageCabalEntry :: !PackageCabal
- packageIdent :: !PackageIdentifier
}
data PackageCabal
- = PCCabalFile !TreeEntry
- | PCHpack !PHpack
data PHpack = PHpack {
- phOriginal :: !TreeEntry
- phGenerated :: !TreeEntry
- phVersion :: !Version
}
data RawPackageLocation
- = RPLImmutable !RawPackageLocationImmutable
- | RPLMutable !(ResolvedPath Dir)
data PackageLocation
- = PLImmutable !PackageLocationImmutable
- | PLMutable !(ResolvedPath Dir)
toRawPL :: PackageLocation -> RawPackageLocation
data RawPackageLocationImmutable
- = RPLIHackage !PackageIdentifierRevision !(Maybe TreeKey)
- | RPLIArchive !RawArchive !RawPackageMetadata
- | RPLIRepo !Repo !RawPackageMetadata
data PackageLocationImmutable
- = PLIHackage !PackageIdentifier !BlobKey !TreeKey
- | PLIArchive !Archive !PackageMetadata
- | PLIRepo !Repo !PackageMetadata
toRawPLI :: PackageLocationImmutable -> RawPackageLocationImmutable
data RawArchive = RawArchive {
- raLocation :: !ArchiveLocation
- raHash :: !(Maybe SHA256)
- raSize :: !(Maybe FileSize)
- raSubdir :: !Text
}
data Archive = Archive {
- archiveLocation :: !ArchiveLocation
- archiveHash :: !SHA256
- archiveSize :: !FileSize
- archiveSubdir :: !Text
}
toRawArchive :: Archive -> RawArchive
data Repo = Repo {
- repoUrl :: !Text
- repoCommit :: !Text
- repoType :: !RepoType
- repoSubdir :: !Text
}
data AggregateRepo = AggregateRepo {
- aRepo :: !SimpleRepo
- aRepoSubdirs :: [(Text, RawPackageMetadata)]
}
data SimpleRepo = SimpleRepo {
- sRepoUrl :: !Text
- sRepoCommit :: !Text
- sRepoType :: !RepoType
}
toAggregateRepos :: [(Repo, RawPackageMetadata)] -> [AggregateRepo]
rToSimpleRepo :: Repo -> SimpleRepo
arToSimpleRepo :: AggregateRepo -> SimpleRepo
data RepoType
- = RepoGit
- | RepoHg
parsePackageIdentifier :: String -> Maybe PackageIdentifier
parsePackageName :: String -> Maybe PackageName
parsePackageNameThrowing :: MonadThrow m => String -> m PackageName
parseFlagName :: String -> Maybe FlagName
parseVersion :: String -> Maybe Version
parseVersionThrowing :: MonadThrow m => String -> m Version
packageIdentifierString :: PackageIdentifier -> String
packageNameString :: PackageName -> String
flagNameString :: FlagName -> String
versionString :: Version -> String
moduleNameString :: ModuleName -> String
data OptionalSubdirs
- = OSSubdirs !(NonEmpty Text)
- | OSPackageMetadata !Text !RawPackageMetadata
data ArchiveLocation
- = ALUrl !Text
- | ALFilePath !(ResolvedPath File)
newtype RelFilePath = RelFilePath Text
newtype CabalString a = CabalString {
- unCabalString :: a
}
toCabalStringMap :: Map a v -> Map (CabalString a) v
unCabalStringMap :: Map (CabalString a) v -> Map a v
parsePackageIdentifierRevision :: Text -> Either PantryException PackageIdentifierRevision
parseRawPackageLocationImmutables :: Text -> Either PantryException (Unresolved (NonEmpty RawPackageLocationImmutable))
data Mismatch a = Mismatch {
- mismatchExpected :: !a
- mismatchActual :: !a
}
data PantryException
- = PackageIdentifierRevisionParseFail !Text
- | RawPackageLocationImmutableParseFail !Text !SomeException
- | RawPackageLocationImmutableParseWarnings !Text ![JSONWarning]
- | InvalidCabalFile !(Either RawPackageLocationImmutable (Path Abs File)) !(Maybe Version) ![PError] ![PWarning]
- | TreeWithoutCabalFile !RawPackageLocationImmutable
- | TreeWithMultipleCabalFiles !RawPackageLocationImmutable ![SafeFilePath]
- | MismatchedCabalName !(Path Abs File) !PackageName
- | NoLocalPackageDirFound !(Path Abs Dir)
- | NoCabalFileFound !(Path Abs Dir)
- | MultipleCabalFilesFound !(Path Abs Dir) ![Path Abs File]
- | InvalidWantedCompiler !Text
- | InvalidSnapshotLocation !(Path Abs Dir) !Text
- | InvalidOverrideCompiler !WantedCompiler !WantedCompiler
- | InvalidFilePathSnapshot !Text
- | InvalidSnapshot !RawSnapshotLocation !SomeException
- | InvalidGlobalHintsLocation !(Path Abs Dir) !Text
- | InvalidFilePathGlobalHints !Text
- | MismatchedPackageMetadata !RawPackageLocationImmutable !RawPackageMetadata !(Maybe TreeKey) !PackageIdentifier
- | Non200ResponseStatus !Status
- | InvalidBlobKey !(Mismatch BlobKey)
- | Couldn'tParseSnapshot !RawSnapshotLocation !String
- | WrongCabalFileName !RawPackageLocationImmutable !SafeFilePath !PackageName
- | DownloadInvalidSHA256 !Text !(Mismatch SHA256)
- | DownloadInvalidSize !Text !(Mismatch FileSize)
- | DownloadTooLarge !Text !(Mismatch FileSize)
- | LocalNoArchiveFileFound !(Path Abs File)
- | LocalInvalidSHA256 !(Path Abs File) !(Mismatch SHA256)
- | LocalInvalidSize !(Path Abs File) !(Mismatch FileSize)
- | UnknownArchiveType !ArchiveLocation
- | InvalidTarFileType !ArchiveLocation !FilePath !FileType
- | UnsupportedTarball !ArchiveLocation !Text
- | NoHackageCryptographicHash !PackageIdentifier
- | FailedToCloneRepo !SimpleRepo
- | TreeReferencesMissingBlob !RawPackageLocationImmutable !SafeFilePath !BlobKey
- | CompletePackageMetadataMismatch !RawPackageLocationImmutable !PackageMetadata
- | CRC32Mismatch !ArchiveLocation !FilePath !(Mismatch Word32)
- | UnknownHackagePackage !PackageIdentifierRevision !FuzzyResults
- | CannotCompleteRepoNonSHA1 !Repo
- | MutablePackageLocationFromUrl !Text
- | MismatchedCabalFileForHackage !PackageIdentifierRevision !(Mismatch PackageIdentifier)
- | PackageNameParseFail !Text
- | PackageVersionParseFail !Text
- | InvalidCabalFilePath !(Path Abs File)
- | DuplicatePackageNames !Utf8Builder ![(PackageName, [RawPackageLocationImmutable])]
- | MigrationFailure !Text !(Path Abs File) !SomeException
- | NoCasaConfig
- | InvalidTreeFromCasa !BlobKey !ByteString
- | ParseSnapNameException !Text
- | HpackLibraryException !(Path Abs File) !String
- | HpackExeException !FilePath !(Path Abs Dir) !SomeException
data FuzzyResults
- = FRNameNotFound ![PackageName]
- | FRVersionNotFound !(NonEmpty PackageIdentifierRevision)
- | FRRevisionNotFound !(NonEmpty PackageIdentifierRevision)
data ResolvedPath t = ResolvedPath {
- resolvedRelative :: !RelFilePath
- resolvedAbsolute :: !(Path Abs t)
}
data HpackExecutable
- = HpackBundled
- | HpackCommand !FilePath
data WantedCompiler
- = WCGhc !Version
- | WCGhcGit !Text !Text
- | WCGhcjs !Version !Version
snapshotLocation :: HasPantryConfig env => SnapName -> RIO env RawSnapshotLocation
defaultSnapshotLocation :: SnapName -> RawSnapshotLocation
globalHintsLocation :: HasPantryConfig env => WantedCompiler -> RIO env GlobalHintsLocation
defaultGlobalHintsLocation :: WantedCompiler -> GlobalHintsLocation
data SnapName
- = LTS !Int !Int
- | Nightly !Day
parseSnapName :: MonadThrow m => Text -> m SnapName
data RawSnapshotLocation
- = RSLCompiler !WantedCompiler
- | RSLUrl !Text !(Maybe BlobKey)
- | RSLFilePath !(ResolvedPath File)
- | RSLSynonym !SnapName
data SnapshotLocation
- = SLCompiler !WantedCompiler
- | SLUrl !Text !BlobKey
- | SLFilePath !(ResolvedPath File)
toRawSL :: SnapshotLocation -> RawSnapshotLocation
parseHackageText :: Text -> Either PantryException (PackageIdentifier, BlobKey)
parseRawSnapshotLocation :: Text -> Unresolved RawSnapshotLocation
data RawSnapshotLayer = RawSnapshotLayer {
- rslParent :: !RawSnapshotLocation
- rslCompiler :: !(Maybe WantedCompiler)
- rslLocations :: ![RawPackageLocationImmutable]
- rslDropPackages :: !(Set PackageName)
- rslFlags :: !(Map PackageName (Map FlagName Bool))
- rslHidden :: !(Map PackageName Bool)
- rslGhcOptions :: !(Map PackageName [Text])
- rslPublishTime :: !(Maybe UTCTime)
}
data SnapshotLayer = SnapshotLayer {
- slParent :: !SnapshotLocation
- slCompiler :: !(Maybe WantedCompiler)
- slLocations :: ![PackageLocationImmutable]
- slDropPackages :: !(Set PackageName)
- slFlags :: !(Map PackageName (Map FlagName Bool))
- slHidden :: !(Map PackageName Bool)
- slGhcOptions :: !(Map PackageName [Text])
- slPublishTime :: !(Maybe UTCTime)
}
toRawSnapshotLayer :: SnapshotLayer -> RawSnapshotLayer
data RawSnapshot = RawSnapshot {
- rsCompiler :: !WantedCompiler
- rsPackages :: !(Map PackageName RawSnapshotPackage)
- rsDrop :: !(Set PackageName)
}
data Snapshot = Snapshot {
- snapshotCompiler :: !WantedCompiler
- snapshotPackages :: !(Map PackageName SnapshotPackage)
- snapshotDrop :: !(Set PackageName)
}
data RawSnapshotPackage = RawSnapshotPackage {
- rspLocation :: !RawPackageLocationImmutable
- rspFlags :: !(Map FlagName Bool)
- rspHidden :: !Bool
- rspGhcOptions :: ![Text]
}
data SnapshotPackage = SnapshotPackage {
- spLocation :: !PackageLocationImmutable
- spFlags :: !(Map FlagName Bool)
- spHidden :: !Bool
- spGhcOptions :: ![Text]
}
data GlobalHintsLocation
- = GHLUrl !Text
- | GHLFilePath !(ResolvedPath File)
parseGlobalHintsLocation :: Text -> Unresolved GlobalHintsLocation
parseWantedCompiler :: Text -> Either PantryException WantedCompiler
data RawPackageMetadata = RawPackageMetadata {
- rpmName :: !(Maybe PackageName)
- rpmVersion :: !(Maybe Version)
- rpmTreeKey :: !(Maybe TreeKey)
}
data PackageMetadata = PackageMetadata {
- pmIdent :: !PackageIdentifier
- pmTreeKey :: !TreeKey
}
toRawPM :: PackageMetadata -> RawPackageMetadata
cabalFileName :: PackageName -> SafeFilePath
newtype SnapshotCacheHash = SnapshotCacheHash {
- unSnapshotCacheHash :: SHA256
}
getGlobalHintsFile :: HasPantryConfig env => RIO env (Path Abs File)
bsToBlobKey :: ByteString -> BlobKey
warnMissingCabalFile :: HasLogFunc env => RawPackageLocationImmutable -> RIO env ()
connRDBMS :: SqlBackend -> Text

Documentation

data PantryConfig Source #

Configuration value used by the entire pantry package. Create one using withPantryConfig or withPantryConfig'. See also PantryApp for a convenience approach to using pantry.

Since: 0.1.0.0

Constructors

PantryConfig

Fields

pcPackageIndex :: !PackageIndexConfig
pcHpackExecutable :: !HpackExecutable
pcHpackForce :: !Force
pcRootDir :: !(Path Abs Dir)
pcStorage :: !Storage
pcUpdateRef :: !(MVar Bool)
Want to try updating the index once during a single run for missing package identifiers. We also want to ensure we only update once at a time. Start at True.
pcParsedCabalFilesRawImmutable :: !(IORef (Map RawPackageLocationImmutable GenericPackageDescription))
Cache of previously parsed cabal files, to save on slow parsing time.
pcParsedCabalFilesMutable :: !(IORef (Map (Path Abs Dir) (PrintWarnings -> IO GenericPackageDescription, PackageName, Path Abs File)))
Cache for mutable packages. We want to allow for an optimization: deferring parsing of the GenericPackageDescription until its actually needed. Therefore, we keep the filepath and the PackageName derived from that filepath. When the IO GenericPackageDescription is run, it will ensure that the PackageName matches the value inside the cabal file, and print out any warnings that still need to be printed.
pcConnectionCount :: !Int
concurrently open downloads
pcCasaConfig :: !(Maybe (CasaRepoPrefix, Int))
Optionally, the Casa pull URL e.g. https://casa.stackage.org and the maximum number of Casa keys to pull per request.
pcSnapshotLocation :: SnapName -> RawSnapshotLocation
The location of snapshot synonyms
pcGlobalHintsLocation :: WantedCompiler -> GlobalHintsLocation
The location of global hints

data PackageIndexConfig Source #

Configuration to securely download package metadata and contents. For most purposes, you'll want to use the default Hackage settings via defaultPackageIndexConfig.

NOTE It's highly recommended to only use the official Hackage server or a mirror. See https://github.com/commercialhaskell/stack/issues/4137.

Since: 0.6.0

Constructors

PackageIndexConfig
Fields picDownloadPrefix :: !Text picHackageSecurityConfig :: !HackageSecurityConfig

Instances

Instances details

Show PackageIndexConfig Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PackageIndexConfig -> ShowS show :: PackageIndexConfig -> String showList :: [PackageIndexConfig] -> ShowS
FromJSON (WithJSONWarnings PackageIndexConfig) Source #	If the `hackage-security` key is absent from the JSON object, assigns default value `defaultHackageSecurityConfig`. Since: 0.6.0
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings PackageIndexConfig) parseJSONList :: Value -> Parser [WithJSONWarnings PackageIndexConfig] omittedField :: Maybe (WithJSONWarnings PackageIndexConfig)

data HackageSecurityConfig Source #

Configuration for Hackage Security to securely download package metadata and contents. For most purposes, you'll want to use the default Hackage settings via defaultHackageSecurityConfig.

NOTE It's highly recommended to only use the official Hackage server or a mirror. See https://github.com/commercialhaskell/stack/issues/4137.

Since: 0.6.0

Constructors

HackageSecurityConfig
Fields hscKeyIds :: ![Text] hscKeyThreshold :: !Int hscIgnoreExpiry :: !Bool

Instances

Instances details

Show HackageSecurityConfig Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> HackageSecurityConfig -> ShowS show :: HackageSecurityConfig -> String showList :: [HackageSecurityConfig] -> ShowS
FromJSON (WithJSONWarnings HackageSecurityConfig) Source #	If the `ignore-expiry` key is absent from the JSON object, assigns default value `True`. Since: 0.1.1.0
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings HackageSecurityConfig) parseJSONList :: Value -> Parser [WithJSONWarnings HackageSecurityConfig] omittedField :: Maybe (WithJSONWarnings HackageSecurityConfig)

defaultHackageSecurityConfig :: HackageSecurityConfig Source #

Default HackageSecurityConfig value using the official Hackage server. The value of the hscIgnoreExpiry field is True.

Since: 0.7.0

data Storage Source #

Represents a SQL database connection.

Constructors

Storage
Fields withStorage_ :: forall env a. HasLogFunc env => ReaderT SqlBackend (RIO env) a -> RIO env a withWriteLock_ :: forall env a. HasLogFunc env => RIO env a -> RIO env a

class HasPantryConfig env where Source #

An environment which contains a PantryConfig.

Since: 0.1.0.0

Methods

pantryConfigL :: Lens' env PantryConfig Source #

Lens to get or set the PantryConfig

Since: 0.1.0.0

data BlobKey Source #

A key for looking up a blob, which combines the SHA256 hash of the contents and the file size.

The file size may seem redundant with the hash. However, it is necessary for safely downloading blobs from an untrusted source. See https://www.fpcomplete.com/blog/2018/07/pantry-part-2-trees-keys.

Since: 0.1.0.0

Constructors

BlobKey !SHA256 !FileSize

Instances

Instances details

FromJSON BlobKey Source #

Instance details

PackageIdentifier
Fields pkgName :: PackageName pkgVersion :: Version

FromJSON PackageNameP Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser PackageNameP parseJSONList :: Value -> Parser [PackageNameP] omittedField :: Maybe PackageNameP
FromJSONKey PackageNameP Source #
Instance details Defined in Pantry.Types Methods fromJSONKey :: FromJSONKeyFunction PackageNameP fromJSONKeyList :: FromJSONKeyFunction [PackageNameP]
ToJSON PackageNameP Source #
Instance details Defined in Pantry.Types Methods toJSON :: PackageNameP -> Value toEncoding :: PackageNameP -> Encoding toJSONList :: [PackageNameP] -> Value toEncodingList :: [PackageNameP] -> Encoding omitField :: PackageNameP -> Bool
ToJSONKey PackageNameP Source #
Instance details Defined in Pantry.Types Methods toJSONKey :: ToJSONKeyFunction PackageNameP toJSONKeyList :: ToJSONKeyFunction [PackageNameP]
NFData PackageNameP Source #
Instance details Defined in Pantry.Types Methods rnf :: PackageNameP -> ()
Read PackageNameP Source #
Instance details Defined in Pantry.Types Methods readsPrec :: Int -> ReadS PackageNameP readList :: ReadS [PackageNameP] readPrec :: ReadPrec PackageNameP readListPrec :: ReadPrec [PackageNameP]
Show PackageNameP Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PackageNameP -> ShowS show :: PackageNameP -> String showList :: [PackageNameP] -> ShowS
Eq PackageNameP Source #
Instance details Defined in Pantry.Types Methods (==) :: PackageNameP -> PackageNameP -> Bool (/=) :: PackageNameP -> PackageNameP -> Bool
Ord PackageNameP Source #
Instance details Defined in Pantry.Types Methods compare :: PackageNameP -> PackageNameP -> Ordering (<) :: PackageNameP -> PackageNameP -> Bool (<=) :: PackageNameP -> PackageNameP -> Bool (>) :: PackageNameP -> PackageNameP -> Bool (>=) :: PackageNameP -> PackageNameP -> Bool max :: PackageNameP -> PackageNameP -> PackageNameP min :: PackageNameP -> PackageNameP -> PackageNameP
PersistField PackageNameP Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: PackageNameP -> PersistValue fromPersistValue :: PersistValue -> Either Text PackageNameP
PersistFieldSql PackageNameP Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy PackageNameP -> SqlType
Display PackageNameP Source #
Instance details Defined in Pantry.Types Methods display :: PackageNameP -> Utf8Builder textDisplay :: PackageNameP -> Text

FromJSON VersionP Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser VersionP parseJSONList :: Value -> Parser [VersionP] omittedField :: Maybe VersionP
ToJSON VersionP Source #
Instance details Defined in Pantry.Types Methods toJSON :: VersionP -> Value toEncoding :: VersionP -> Encoding toJSONList :: [VersionP] -> Value toEncodingList :: [VersionP] -> Encoding omitField :: VersionP -> Bool
NFData VersionP Source #
Instance details Defined in Pantry.Types Methods rnf :: VersionP -> ()
Read VersionP Source #
Instance details Defined in Pantry.Types Methods readsPrec :: Int -> ReadS VersionP readList :: ReadS [VersionP] readPrec :: ReadPrec VersionP readListPrec :: ReadPrec [VersionP]
Show VersionP Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> VersionP -> ShowS show :: VersionP -> String showList :: [VersionP] -> ShowS
Eq VersionP Source #
Instance details Defined in Pantry.Types Methods (==) :: VersionP -> VersionP -> Bool (/=) :: VersionP -> VersionP -> Bool
Ord VersionP Source #
Instance details Defined in Pantry.Types Methods compare :: VersionP -> VersionP -> Ordering (<) :: VersionP -> VersionP -> Bool (<=) :: VersionP -> VersionP -> Bool (>) :: VersionP -> VersionP -> Bool (>=) :: VersionP -> VersionP -> Bool max :: VersionP -> VersionP -> VersionP min :: VersionP -> VersionP -> VersionP
PersistField VersionP Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: VersionP -> PersistValue fromPersistValue :: PersistValue -> Either Text VersionP
PersistFieldSql VersionP Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy VersionP -> SqlType
Display VersionP Source #
Instance details Defined in Pantry.Types Methods display :: VersionP -> Utf8Builder textDisplay :: VersionP -> Text

NFData ModuleNameP Source #
Instance details Defined in Pantry.Types Methods rnf :: ModuleNameP -> ()
Show ModuleNameP Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> ModuleNameP -> ShowS show :: ModuleNameP -> String showList :: [ModuleNameP] -> ShowS
Eq ModuleNameP Source #
Instance details Defined in Pantry.Types Methods (==) :: ModuleNameP -> ModuleNameP -> Bool (/=) :: ModuleNameP -> ModuleNameP -> Bool
Ord ModuleNameP Source #
Instance details Defined in Pantry.Types Methods compare :: ModuleNameP -> ModuleNameP -> Ordering (<) :: ModuleNameP -> ModuleNameP -> Bool (<=) :: ModuleNameP -> ModuleNameP -> Bool (>) :: ModuleNameP -> ModuleNameP -> Bool (>=) :: ModuleNameP -> ModuleNameP -> Bool max :: ModuleNameP -> ModuleNameP -> ModuleNameP min :: ModuleNameP -> ModuleNameP -> ModuleNameP
PersistField ModuleNameP Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: ModuleNameP -> PersistValue fromPersistValue :: PersistValue -> Either Text ModuleNameP
PersistFieldSql ModuleNameP Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy ModuleNameP -> SqlType
Display ModuleNameP Source #
Instance details Defined in Pantry.Types Methods display :: ModuleNameP -> Utf8Builder textDisplay :: ModuleNameP -> Text

Bounded FileType Source #
Instance details Defined in Pantry.Types Methods minBound :: FileType maxBound :: FileType
Enum FileType Source #
Instance details Defined in Pantry.Types Methods succ :: FileType -> FileType pred :: FileType -> FileType toEnum :: Int -> FileType fromEnum :: FileType -> Int enumFrom :: FileType -> [FileType] enumFromThen :: FileType -> FileType -> [FileType] enumFromTo :: FileType -> FileType -> [FileType] enumFromThenTo :: FileType -> FileType -> FileType -> [FileType]
Show FileType Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> FileType -> ShowS show :: FileType -> String showList :: [FileType] -> ShowS
Eq FileType Source #
Instance details Defined in Pantry.Types Methods (==) :: FileType -> FileType -> Bool (/=) :: FileType -> FileType -> Bool
Ord FileType Source #
Instance details Defined in Pantry.Types Methods compare :: FileType -> FileType -> Ordering (<) :: FileType -> FileType -> Bool (<=) :: FileType -> FileType -> Bool (>) :: FileType -> FileType -> Bool (>=) :: FileType -> FileType -> Bool max :: FileType -> FileType -> FileType min :: FileType -> FileType -> FileType
PersistField FileType Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: FileType -> PersistValue fromPersistValue :: PersistValue -> Either Text FileType
PersistFieldSql FileType Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy FileType -> SqlType

Show BuildFile Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> BuildFile -> ShowS show :: BuildFile -> String showList :: [BuildFile] -> ShowS
Eq BuildFile Source #
Instance details Defined in Pantry.Types Methods (==) :: BuildFile -> BuildFile -> Bool (/=) :: BuildFile -> BuildFile -> Bool

Show TreeEntry Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> TreeEntry -> ShowS show :: TreeEntry -> String showList :: [TreeEntry] -> ShowS
Eq TreeEntry Source #
Instance details Defined in Pantry.Types Methods (==) :: TreeEntry -> TreeEntry -> Bool (/=) :: TreeEntry -> TreeEntry -> Bool
Ord TreeEntry Source #
Instance details Defined in Pantry.Types Methods compare :: TreeEntry -> TreeEntry -> Ordering (<) :: TreeEntry -> TreeEntry -> Bool (<=) :: TreeEntry -> TreeEntry -> Bool (>) :: TreeEntry -> TreeEntry -> Bool (>=) :: TreeEntry -> TreeEntry -> Bool max :: TreeEntry -> TreeEntry -> TreeEntry min :: TreeEntry -> TreeEntry -> TreeEntry

Show SafeFilePath Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> SafeFilePath -> ShowS show :: SafeFilePath -> String showList :: [SafeFilePath] -> ShowS
Eq SafeFilePath Source #
Instance details Defined in Pantry.Types Methods (==) :: SafeFilePath -> SafeFilePath -> Bool (/=) :: SafeFilePath -> SafeFilePath -> Bool
Ord SafeFilePath Source #
Instance details Defined in Pantry.Types Methods compare :: SafeFilePath -> SafeFilePath -> Ordering (<) :: SafeFilePath -> SafeFilePath -> Bool (<=) :: SafeFilePath -> SafeFilePath -> Bool (>) :: SafeFilePath -> SafeFilePath -> Bool (>=) :: SafeFilePath -> SafeFilePath -> Bool max :: SafeFilePath -> SafeFilePath -> SafeFilePath min :: SafeFilePath -> SafeFilePath -> SafeFilePath
PersistField SafeFilePath Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: SafeFilePath -> PersistValue fromPersistValue :: PersistValue -> Either Text SafeFilePath
PersistFieldSql SafeFilePath Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy SafeFilePath -> SqlType
Display SafeFilePath Source #
Instance details Defined in Pantry.Types Methods display :: SafeFilePath -> Utf8Builder textDisplay :: SafeFilePath -> Text

Show Tree Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> Tree -> ShowS show :: Tree -> String showList :: [Tree] -> ShowS
Eq Tree Source #
Instance details Defined in Pantry.Types Methods (==) :: Tree -> Tree -> Bool (/=) :: Tree -> Tree -> Bool
Ord Tree Source #
Instance details Defined in Pantry.Types Methods compare :: Tree -> Tree -> Ordering (<) :: Tree -> Tree -> Bool (<=) :: Tree -> Tree -> Bool (>) :: Tree -> Tree -> Bool (>=) :: Tree -> Tree -> Bool max :: Tree -> Tree -> Tree min :: Tree -> Tree -> Tree

Applicative Unresolved Source #
Instance details Defined in Pantry.Types Methods pure :: a -> Unresolved a (<>) :: Unresolved (a -> b) -> Unresolved a -> Unresolved b liftA2 :: (a -> b -> c) -> Unresolved a -> Unresolved b -> Unresolved c (>) :: Unresolved a -> Unresolved b -> Unresolved b (<*) :: Unresolved a -> Unresolved b -> Unresolved a
Functor Unresolved Source #
Instance details Defined in Pantry.Types Methods fmap :: (a -> b) -> Unresolved a -> Unresolved b (<$) :: a -> Unresolved b -> Unresolved a
FromJSON (WithJSONWarnings (Unresolved (NonEmpty RawPackageLocation))) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved (NonEmpty RawPackageLocation))) parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved (NonEmpty RawPackageLocation))] omittedField :: Maybe (WithJSONWarnings (Unresolved (NonEmpty RawPackageLocation)))
FromJSON (WithJSONWarnings (Unresolved (NonEmpty RawPackageLocationImmutable))) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved (NonEmpty RawPackageLocationImmutable))) parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved (NonEmpty RawPackageLocationImmutable))] omittedField :: Maybe (WithJSONWarnings (Unresolved (NonEmpty RawPackageLocationImmutable)))
FromJSON (WithJSONWarnings (Unresolved GlobalHintsLocation)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved GlobalHintsLocation)) parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved GlobalHintsLocation)] omittedField :: Maybe (WithJSONWarnings (Unresolved GlobalHintsLocation))
FromJSON (WithJSONWarnings (Unresolved PackageLocationImmutable)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved PackageLocationImmutable)) parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved PackageLocationImmutable)] omittedField :: Maybe (WithJSONWarnings (Unresolved PackageLocationImmutable))
FromJSON (WithJSONWarnings (Unresolved RawSnapshotLayer)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved RawSnapshotLayer)) parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved RawSnapshotLayer)] omittedField :: Maybe (WithJSONWarnings (Unresolved RawSnapshotLayer))
FromJSON (WithJSONWarnings (Unresolved RawSnapshotLocation)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved RawSnapshotLocation)) parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved RawSnapshotLocation)] omittedField :: Maybe (WithJSONWarnings (Unresolved RawSnapshotLocation))
FromJSON (WithJSONWarnings (Unresolved SnapshotLocation)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved SnapshotLocation)) parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved SnapshotLocation)] omittedField :: Maybe (WithJSONWarnings (Unresolved SnapshotLocation))

:: MonadIO m
=> Maybe (Path Abs Dir)	directory to use for relative paths
-> Unresolved a
-> m a

Show Package Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> Package -> ShowS show :: Package -> String showList :: [Package] -> ShowS
Eq Package Source #
Instance details Defined in Pantry.Types Methods (==) :: Package -> Package -> Bool (/=) :: Package -> Package -> Bool
Ord Package Source #
Instance details Defined in Pantry.Types Methods compare :: Package -> Package -> Ordering (<) :: Package -> Package -> Bool (<=) :: Package -> Package -> Bool (>) :: Package -> Package -> Bool (>=) :: Package -> Package -> Bool max :: Package -> Package -> Package min :: Package -> Package -> Package

PCCabalFile !TreeEntry	TreeEntry of Cabal file
PCHpack !PHpack

Show PackageCabal Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PackageCabal -> ShowS show :: PackageCabal -> String showList :: [PackageCabal] -> ShowS
Eq PackageCabal Source #
Instance details Defined in Pantry.Types Methods (==) :: PackageCabal -> PackageCabal -> Bool (/=) :: PackageCabal -> PackageCabal -> Bool
Ord PackageCabal Source #
Instance details Defined in Pantry.Types Methods compare :: PackageCabal -> PackageCabal -> Ordering (<) :: PackageCabal -> PackageCabal -> Bool (<=) :: PackageCabal -> PackageCabal -> Bool (>) :: PackageCabal -> PackageCabal -> Bool (>=) :: PackageCabal -> PackageCabal -> Bool max :: PackageCabal -> PackageCabal -> PackageCabal min :: PackageCabal -> PackageCabal -> PackageCabal

PHpack
Fields phOriginal :: !TreeEntry Original hpack file phGenerated :: !TreeEntry Generated Cabal file phVersion :: !Version Version of Hpack used

Show PHpack Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PHpack -> ShowS show :: PHpack -> String showList :: [PHpack] -> ShowS
Eq PHpack Source #
Instance details Defined in Pantry.Types Methods (==) :: PHpack -> PHpack -> Bool (/=) :: PHpack -> PHpack -> Bool
Ord PHpack Source #
Instance details Defined in Pantry.Types Methods compare :: PHpack -> PHpack -> Ordering (<) :: PHpack -> PHpack -> Bool (<=) :: PHpack -> PHpack -> Bool (>) :: PHpack -> PHpack -> Bool (>=) :: PHpack -> PHpack -> Bool max :: PHpack -> PHpack -> PHpack min :: PHpack -> PHpack -> PHpack

RPLImmutable !RawPackageLocationImmutable
RPLMutable !(ResolvedPath Dir)

PLImmutable !PackageLocationImmutable
PLMutable !(ResolvedPath Dir)

RPLIHackage !PackageIdentifierRevision !(Maybe TreeKey)
RPLIArchive !RawArchive !RawPackageMetadata
RPLIRepo !Repo !RawPackageMetadata

PLIHackage !PackageIdentifier !BlobKey !TreeKey
PLIArchive !Archive !PackageMetadata
PLIRepo !Repo !PackageMetadata

RawArchive
Fields raLocation :: !ArchiveLocation Location of the archive Since: 0.1.0.0 raHash :: !(Maybe SHA256) Cryptographic hash of the archive file Since: 0.1.0.0 raSize :: !(Maybe FileSize) Size of the archive file Since: 0.1.0.0 raSubdir :: !Text Subdirectory within the archive to get the package from. Since: 0.1.0.0

Archive
Fields archiveLocation :: !ArchiveLocation Location of the archive Since: 0.1.0.0 archiveHash :: !SHA256 Cryptographic hash of the archive file Since: 0.1.0.0 archiveSize :: !FileSize Size of the archive file Since: 0.1.0.0 archiveSubdir :: !Text Subdirectory within the archive to get the package from. Since: 0.1.0.0

Repo
Fields repoUrl :: !Text Location of the repo Since: 0.1.0.0 repoCommit :: !Text Commit to use from the repo. It's strongly recommended to use a hash instead of a tag or branch name. Since: 0.1.0.0 repoType :: !RepoType The type of the repo Since: 0.1.0.0 repoSubdir :: !Text Subdirectory within the archive to get the package from. Since: 0.1.0.0

AggregateRepo
Fields aRepo :: !SimpleRepo aRepoSubdirs :: [(Text, RawPackageMetadata)]

SimpleRepo
Fields sRepoUrl :: !Text sRepoCommit :: !Text sRepoType :: !RepoType

OSSubdirs !(NonEmpty Text)
OSPackageMetadata !Text !RawPackageMetadata	subdirectory and package metadata

IsCabalString a => FromJSON (CabalString a) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (CabalString a) parseJSONList :: Value -> Parser [CabalString a] omittedField :: Maybe (CabalString a)
IsCabalString a => FromJSONKey (CabalString a) Source #
Instance details Defined in Pantry.Types Methods fromJSONKey :: FromJSONKeyFunction (CabalString a) fromJSONKeyList :: FromJSONKeyFunction [CabalString a]
Pretty a => ToJSON (CabalString a) Source #
Instance details Defined in Pantry.Types Methods toJSON :: CabalString a -> Value toEncoding :: CabalString a -> Encoding toJSONList :: [CabalString a] -> Value toEncodingList :: [CabalString a] -> Encoding omitField :: CabalString a -> Bool
Pretty a => ToJSONKey (CabalString a) Source #
Instance details Defined in Pantry.Types Methods toJSONKey :: ToJSONKeyFunction (CabalString a) toJSONKeyList :: ToJSONKeyFunction [CabalString a]
Show a => Show (CabalString a) Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> CabalString a -> ShowS show :: CabalString a -> String showList :: [CabalString a] -> ShowS
Eq a => Eq (CabalString a) Source #
Instance details Defined in Pantry.Types Methods (==) :: CabalString a -> CabalString a -> Bool (/=) :: CabalString a -> CabalString a -> Bool
Ord a => Ord (CabalString a) Source #
Instance details Defined in Pantry.Types Methods compare :: CabalString a -> CabalString a -> Ordering (<) :: CabalString a -> CabalString a -> Bool (<=) :: CabalString a -> CabalString a -> Bool (>) :: CabalString a -> CabalString a -> Bool (>=) :: CabalString a -> CabalString a -> Bool max :: CabalString a -> CabalString a -> CabalString a min :: CabalString a -> CabalString a -> CabalString a

:: Text	A YAML value.
-> Either PantryException (Unresolved (NonEmpty RawPackageLocationImmutable))

PackageIdentifierRevisionParseFail !Text
RawPackageLocationImmutableParseFail !Text !SomeException
RawPackageLocationImmutableParseWarnings !Text ![JSONWarning]
InvalidCabalFile !(Either RawPackageLocationImmutable (Path Abs File)) !(Maybe Version) ![PError] ![PWarning]
TreeWithoutCabalFile !RawPackageLocationImmutable
TreeWithMultipleCabalFiles !RawPackageLocationImmutable ![SafeFilePath]
MismatchedCabalName !(Path Abs File) !PackageName
NoLocalPackageDirFound !(Path Abs Dir)
NoCabalFileFound !(Path Abs Dir)
MultipleCabalFilesFound !(Path Abs Dir) ![Path Abs File]
InvalidWantedCompiler !Text
InvalidSnapshotLocation !(Path Abs Dir) !Text
InvalidOverrideCompiler !WantedCompiler !WantedCompiler
InvalidFilePathSnapshot !Text
InvalidSnapshot !RawSnapshotLocation !SomeException
InvalidGlobalHintsLocation !(Path Abs Dir) !Text
InvalidFilePathGlobalHints !Text
MismatchedPackageMetadata !RawPackageLocationImmutable !RawPackageMetadata !(Maybe TreeKey) !PackageIdentifier
Non200ResponseStatus !Status
InvalidBlobKey !(Mismatch BlobKey)
Couldn'tParseSnapshot !RawSnapshotLocation !String
WrongCabalFileName !RawPackageLocationImmutable !SafeFilePath !PackageName
DownloadInvalidSHA256 !Text !(Mismatch SHA256)
DownloadInvalidSize !Text !(Mismatch FileSize)
DownloadTooLarge !Text !(Mismatch FileSize)	Different from `DownloadInvalidSize` since `mismatchActual` is a lower bound on the size from the server.
LocalNoArchiveFileFound !(Path Abs File)
LocalInvalidSHA256 !(Path Abs File) !(Mismatch SHA256)
LocalInvalidSize !(Path Abs File) !(Mismatch FileSize)
UnknownArchiveType !ArchiveLocation
InvalidTarFileType !ArchiveLocation !FilePath !FileType
UnsupportedTarball !ArchiveLocation !Text
NoHackageCryptographicHash !PackageIdentifier
FailedToCloneRepo !SimpleRepo
TreeReferencesMissingBlob !RawPackageLocationImmutable !SafeFilePath !BlobKey
CompletePackageMetadataMismatch !RawPackageLocationImmutable !PackageMetadata
CRC32Mismatch !ArchiveLocation !FilePath !(Mismatch Word32)
UnknownHackagePackage !PackageIdentifierRevision !FuzzyResults
CannotCompleteRepoNonSHA1 !Repo
MutablePackageLocationFromUrl !Text
MismatchedCabalFileForHackage !PackageIdentifierRevision !(Mismatch PackageIdentifier)
PackageNameParseFail !Text
PackageVersionParseFail !Text
InvalidCabalFilePath !(Path Abs File)
DuplicatePackageNames !Utf8Builder ![(PackageName, [RawPackageLocationImmutable])]
MigrationFailure !Text !(Path Abs File) !SomeException
NoCasaConfig
InvalidTreeFromCasa !BlobKey !ByteString
ParseSnapNameException !Text
HpackLibraryException !(Path Abs File) !String
HpackExeException !FilePath !(Path Abs Dir) !SomeException

Exception PantryException Source #
Instance details Defined in Pantry.Types Methods toException :: PantryException -> SomeException fromException :: SomeException -> Maybe PantryException displayException :: PantryException -> String backtraceDesired :: PantryException -> Bool
Show PantryException Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PantryException -> ShowS show :: PantryException -> String showList :: [PantryException] -> ShowS
Display PantryException Source #
Instance details Defined in Pantry.Types Methods display :: PantryException -> Utf8Builder textDisplay :: PantryException -> Text
Pretty PantryException Source #
Instance details Defined in Pantry.Types Methods pretty :: PantryException -> StyleDoc