Safe Haskell	Safe-Inferred
Language	Haskell2010

Pantry.Types

Synopsis

data PantryConfig = PantryConfig {
- pcPackageIndex :: !PackageIndexConfig
- pcHpackExecutable :: !HpackExecutable
- 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
}
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
data Mismatch a = Mismatch {
- mismatchExpected :: !a
- mismatchActual :: !a
}
data PantryException
- = PackageIdentifierRevisionParseFail !Text
- | 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
- | 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)
- | 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
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]
}
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
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

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] #

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] #

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 Defined in Pantry.Types Methods parseJSON :: Value -> Parser BlobKey # parseJSONList :: Value -> Parser [BlobKey] #
ToJSON BlobKey Source #
Instance details Defined in Pantry.Types Methods toJSON :: BlobKey -> Value # toEncoding :: BlobKey -> Encoding # toJSONList :: [BlobKey] -> Value # toEncodingList :: [BlobKey] -> Encoding #
Generic BlobKey Source #
Instance details Defined in Pantry.Types Associated Types type Rep BlobKey :: Type -> Type # Methods from :: BlobKey -> Rep BlobKey x # to :: Rep BlobKey x -> BlobKey #
Show BlobKey Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> BlobKey -> ShowS # show :: BlobKey -> String # showList :: [BlobKey] -> ShowS #
NFData BlobKey Source #
Instance details Defined in Pantry.Types Methods rnf :: BlobKey -> () #
Eq BlobKey Source #
Instance details Defined in Pantry.Types Methods (==) :: BlobKey -> BlobKey -> Bool # (/=) :: BlobKey -> BlobKey -> Bool #
Ord BlobKey Source #
Instance details Defined in Pantry.Types Methods compare :: BlobKey -> BlobKey -> Ordering # (<) :: BlobKey -> BlobKey -> Bool # (<=) :: BlobKey -> BlobKey -> Bool # (>) :: BlobKey -> BlobKey -> Bool # (>=) :: BlobKey -> BlobKey -> Bool # max :: BlobKey -> BlobKey -> BlobKey # min :: BlobKey -> BlobKey -> BlobKey #
Display BlobKey Source #
Instance details Defined in Pantry.Types Methods display :: BlobKey -> Utf8Builder # textDisplay :: BlobKey -> Text #
type Rep BlobKey Source #
Instance details Defined in Pantry.Types type Rep BlobKey = D1 ('MetaData "BlobKey" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "BlobKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SHA256) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FileSize)))

data PackageName #

A package name.

Use mkPackageName and unPackageName to convert from/to a String.

This type is opaque since Cabal-2.0

Since: Cabal-2.0.0.2

Instances

Instances details

Parsec PackageName
Instance details Defined in Distribution.Types.PackageName Methods parsec :: CabalParsing m => m PackageName #
Pretty PackageName
Instance details Defined in Distribution.Types.PackageName Methods pretty :: PackageName -> Doc # prettyVersioned :: CabalSpecVersion -> PackageName -> Doc #
Structured PackageName
Instance details Defined in Distribution.Types.PackageName Methods structure :: Proxy PackageName -> Structure # structureHash' :: Tagged PackageName MD5
Data PackageName
Instance details Defined in Distribution.Types.PackageName Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageName -> c PackageName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageName # toConstr :: PackageName -> Constr # dataTypeOf :: PackageName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageName) # gmapT :: (forall b. Data b => b -> b) -> PackageName -> PackageName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageName -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageName -> r # gmapQ :: (forall d. Data d => d -> u) -> PackageName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageName -> m PackageName #
IsString PackageName	`mkPackageName` Since: Cabal-2.0.0.2
Instance details Defined in Distribution.Types.PackageName Methods fromString :: String -> PackageName #
Generic PackageName
Instance details Defined in Distribution.Types.PackageName Associated Types type Rep PackageName :: Type -> Type # Methods from :: PackageName -> Rep PackageName x # to :: Rep PackageName x -> PackageName #
Read PackageName
Instance details Defined in Distribution.Types.PackageName Methods readsPrec :: Int -> ReadS PackageName # readList :: ReadS [PackageName] # readPrec :: ReadPrec PackageName # readListPrec :: ReadPrec [PackageName] #
Show PackageName
Instance details Defined in Distribution.Types.PackageName Methods showsPrec :: Int -> PackageName -> ShowS # show :: PackageName -> String # showList :: [PackageName] -> ShowS #
Binary PackageName
Instance details Defined in Distribution.Types.PackageName Methods put :: PackageName -> Put # get :: Get PackageName # putList :: [PackageName] -> Put #
NFData PackageName
Instance details Defined in Distribution.Types.PackageName Methods rnf :: PackageName -> () #
Eq PackageName
Instance details Defined in Distribution.Types.PackageName Methods (==) :: PackageName -> PackageName -> Bool # (/=) :: PackageName -> PackageName -> Bool #
Ord PackageName
Instance details Defined in Distribution.Types.PackageName Methods compare :: PackageName -> PackageName -> Ordering # (<) :: PackageName -> PackageName -> Bool # (<=) :: PackageName -> PackageName -> Bool # (>) :: PackageName -> PackageName -> Bool # (>=) :: PackageName -> PackageName -> Bool # max :: PackageName -> PackageName -> PackageName # min :: PackageName -> PackageName -> PackageName #
type Rep PackageName
Instance details Defined in Distribution.Types.PackageName type Rep PackageName = D1 ('MetaData "PackageName" "Distribution.Types.PackageName" "Cabal-3.6.3.0" 'True) (C1 ('MetaCons "PackageName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortText)))

data Version #

A Version represents the version of a software entity.

Instances of Eq and Ord are provided, which gives exact equality and lexicographic ordering of the version number components (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).

This type is opaque and distinct from the Version type in Data.Version since Cabal-2.0. The difference extends to the Binary instance using a different (and more compact) encoding.

Since: Cabal-2.0.0.2

Instances

Instances details

Parsec Version
Instance details Defined in Distribution.Types.Version Methods parsec :: CabalParsing m => m Version #
Pretty Version
Instance details Defined in Distribution.Types.Version Methods pretty :: Version -> Doc # prettyVersioned :: CabalSpecVersion -> Version -> Doc #
Structured Version
Instance details Defined in Distribution.Types.Version Methods structure :: Proxy Version -> Structure # structureHash' :: Tagged Version MD5
Data Version
Instance details Defined in Distribution.Types.Version Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version # toConstr :: Version -> Constr # dataTypeOf :: Version -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) # gmapT :: (forall b. Data b => b -> b) -> Version -> Version # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #
Generic Version
Instance details Defined in Distribution.Types.Version Associated Types type Rep Version :: Type -> Type # Methods from :: Version -> Rep Version x # to :: Rep Version x -> Version #
Read Version
Instance details Defined in Distribution.Types.Version Methods readsPrec :: Int -> ReadS Version # readList :: ReadS [Version] # readPrec :: ReadPrec Version # readListPrec :: ReadPrec [Version] #
Show Version
Instance details Defined in Distribution.Types.Version Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Binary Version
Instance details Defined in Distribution.Types.Version Methods put :: Version -> Put # get :: Get Version # putList :: [Version] -> Put #
NFData Version
Instance details Defined in Distribution.Types.Version Methods rnf :: Version -> () #
Eq Version
Instance details Defined in Distribution.Types.Version Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version
Instance details Defined in Distribution.Types.Version Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
type Rep Version
Instance details Defined in Distribution.Types.Version type Rep Version = D1 ('MetaData "Version" "Distribution.Types.Version" "Cabal-3.6.3.0" 'False) (C1 ('MetaCons "PV0" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Word64)) :+: C1 ('MetaCons "PV1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int])))

data PackageIdentifier #

The name and version of a package.

Constructors

PackageIdentifier
Fields pkgName :: PackageName The name of this package, eg. foo pkgVersion :: Version the version of this package, eg 1.2

Instances

Instances details

Parsec PackageIdentifier	`>>>` `simpleParsec "foo-bar-0" :: Maybe PackageIdentifier`Just (PackageIdentifier {pkgName = PackageName "foo-bar", pkgVersion = mkVersion [0]}) `>>>` `simpleParsec "foo-bar" :: Maybe PackageIdentifier`Just (PackageIdentifier {pkgName = PackageName "foo-bar", pkgVersion = mkVersion []}) Note: Stricter than `Text` instance `>>>` `simpleParsec "foo-bar-0-0" :: Maybe PackageIdentifier`Nothing `>>>` `simpleParsec "foo-bar.0" :: Maybe PackageIdentifier`Nothing `>>>` `simpleParsec "foo-bar.4-2" :: Maybe PackageIdentifier`Nothing `>>>` `simpleParsec "1.2.3" :: Maybe PackageIdentifier`Nothing
Instance details Defined in Distribution.Types.PackageId Methods parsec :: CabalParsing m => m PackageIdentifier #
Pretty PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods pretty :: PackageIdentifier -> Doc # prettyVersioned :: CabalSpecVersion -> PackageIdentifier -> Doc #
Structured PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods structure :: Proxy PackageIdentifier -> Structure # structureHash' :: Tagged PackageIdentifier MD5
Data PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageIdentifier -> c PackageIdentifier # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageIdentifier # toConstr :: PackageIdentifier -> Constr # dataTypeOf :: PackageIdentifier -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageIdentifier) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageIdentifier) # gmapT :: (forall b. Data b => b -> b) -> PackageIdentifier -> PackageIdentifier # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageIdentifier -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageIdentifier -> r # gmapQ :: (forall d. Data d => d -> u) -> PackageIdentifier -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageIdentifier -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageIdentifier -> m PackageIdentifier #
Generic PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Associated Types type Rep PackageIdentifier :: Type -> Type # Methods from :: PackageIdentifier -> Rep PackageIdentifier x # to :: Rep PackageIdentifier x -> PackageIdentifier #
Read PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods readsPrec :: Int -> ReadS PackageIdentifier # readList :: ReadS [PackageIdentifier] # readPrec :: ReadPrec PackageIdentifier # readListPrec :: ReadPrec [PackageIdentifier] #
Show PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods showsPrec :: Int -> PackageIdentifier -> ShowS # show :: PackageIdentifier -> String # showList :: [PackageIdentifier] -> ShowS #
Binary PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods put :: PackageIdentifier -> Put # get :: Get PackageIdentifier # putList :: [PackageIdentifier] -> Put #
NFData PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods rnf :: PackageIdentifier -> () #
Eq PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods (==) :: PackageIdentifier -> PackageIdentifier -> Bool # (/=) :: PackageIdentifier -> PackageIdentifier -> Bool #
Ord PackageIdentifier
Instance details Defined in Distribution.Types.PackageId Methods compare :: PackageIdentifier -> PackageIdentifier -> Ordering # (<) :: PackageIdentifier -> PackageIdentifier -> Bool # (<=) :: PackageIdentifier -> PackageIdentifier -> Bool # (>) :: PackageIdentifier -> PackageIdentifier -> Bool # (>=) :: PackageIdentifier -> PackageIdentifier -> Bool # max :: PackageIdentifier -> PackageIdentifier -> PackageIdentifier # min :: PackageIdentifier -> PackageIdentifier -> PackageIdentifier #
type Rep PackageIdentifier
Instance details Defined in Distribution.Types.PackageId type Rep PackageIdentifier = D1 ('MetaData "PackageIdentifier" "Distribution.Types.PackageId" "Cabal-3.6.3.0" 'False) (C1 ('MetaCons "PackageIdentifier" 'PrefixI 'True) (S1 ('MetaSel ('Just "pkgName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: S1 ('MetaSel ('Just "pkgVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))

newtype Revision Source #

The revision number of a package from Hackage, counting upwards from 0 (the original cabal file).

See caveats on CFIRevision.

Since: 0.1.0.0

Constructors

Revision Word

Instances

Instances details

Data Revision Source #
Instance details Defined in Pantry.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Revision -> c Revision # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Revision # toConstr :: Revision -> Constr # dataTypeOf :: Revision -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Revision) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Revision) # gmapT :: (forall b. Data b => b -> b) -> Revision -> Revision # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Revision -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Revision -> r # gmapQ :: (forall d. Data d => d -> u) -> Revision -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Revision -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Revision -> m Revision # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Revision -> m Revision # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Revision -> m Revision #
Generic Revision Source #
Instance details Defined in Pantry.Types Associated Types type Rep Revision :: Type -> Type # Methods from :: Revision -> Rep Revision x # to :: Rep Revision x -> Revision #
Show Revision Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> Revision -> ShowS # show :: Revision -> String # showList :: [Revision] -> ShowS #
NFData Revision Source #
Instance details Defined in Pantry.Types Methods rnf :: Revision -> () #
Eq Revision Source #
Instance details Defined in Pantry.Types Methods (==) :: Revision -> Revision -> Bool # (/=) :: Revision -> Revision -> Bool #
Ord Revision Source #
Instance details Defined in Pantry.Types Methods compare :: Revision -> Revision -> Ordering # (<) :: Revision -> Revision -> Bool # (<=) :: Revision -> Revision -> Bool # (>) :: Revision -> Revision -> Bool # (>=) :: Revision -> Revision -> Bool # max :: Revision -> Revision -> Revision # min :: Revision -> Revision -> Revision #
Hashable Revision Source #
Instance details Defined in Pantry.Types Methods hashWithSalt :: Int -> Revision -> Int # hash :: Revision -> Int #
PersistField Revision Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: Revision -> PersistValue # fromPersistValue :: PersistValue -> Either Text Revision #
PersistFieldSql Revision Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy Revision -> SqlType #
Display Revision Source #
Instance details Defined in Pantry.Types Methods display :: Revision -> Utf8Builder # textDisplay :: Revision -> Text #
type Rep Revision Source #
Instance details Defined in Pantry.Types type Rep Revision = D1 ('MetaData "Revision" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'True) (C1 ('MetaCons "Revision" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

data ModuleName #

A valid Haskell module name.

Instances

Instances details

Parsec ModuleName
Instance details Defined in Distribution.ModuleName Methods parsec :: CabalParsing m => m ModuleName #
Pretty ModuleName
Instance details Defined in Distribution.ModuleName Methods pretty :: ModuleName -> Doc # prettyVersioned :: CabalSpecVersion -> ModuleName -> Doc #
Structured ModuleName
Instance details Defined in Distribution.ModuleName Methods structure :: Proxy ModuleName -> Structure # structureHash' :: Tagged ModuleName MD5
Data ModuleName
Instance details Defined in Distribution.ModuleName Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleName -> c ModuleName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleName # toConstr :: ModuleName -> Constr # dataTypeOf :: ModuleName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleName) # gmapT :: (forall b. Data b => b -> b) -> ModuleName -> ModuleName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQ :: (forall d. Data d => d -> u) -> ModuleName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName #
IsString ModuleName	Construct a `ModuleName` from a valid module name `String`. This is just a convenience function intended for valid module strings. It is an error if it is used with a string that is not a valid module name. If you are parsing user input then use `simpleParse` instead.
Instance details Defined in Distribution.ModuleName Methods fromString :: String -> ModuleName #
Generic ModuleName
Instance details Defined in Distribution.ModuleName Associated Types type Rep ModuleName :: Type -> Type # Methods from :: ModuleName -> Rep ModuleName x # to :: Rep ModuleName x -> ModuleName #
Read ModuleName
Instance details Defined in Distribution.ModuleName Methods readsPrec :: Int -> ReadS ModuleName # readList :: ReadS [ModuleName] # readPrec :: ReadPrec ModuleName # readListPrec :: ReadPrec [ModuleName] #
Show ModuleName
Instance details Defined in Distribution.ModuleName Methods showsPrec :: Int -> ModuleName -> ShowS # show :: ModuleName -> String # showList :: [ModuleName] -> ShowS #
Binary ModuleName
Instance details Defined in Distribution.ModuleName Methods put :: ModuleName -> Put # get :: Get ModuleName # putList :: [ModuleName] -> Put #
NFData ModuleName
Instance details Defined in Distribution.ModuleName Methods rnf :: ModuleName -> () #
Eq ModuleName
Instance details Defined in Distribution.ModuleName Methods (==) :: ModuleName -> ModuleName -> Bool # (/=) :: ModuleName -> ModuleName -> Bool #
Ord ModuleName
Instance details Defined in Distribution.ModuleName Methods compare :: ModuleName -> ModuleName -> Ordering # (<) :: ModuleName -> ModuleName -> Bool # (<=) :: ModuleName -> ModuleName -> Bool # (>) :: ModuleName -> ModuleName -> Bool # (>=) :: ModuleName -> ModuleName -> Bool # max :: ModuleName -> ModuleName -> ModuleName # min :: ModuleName -> ModuleName -> ModuleName #
Pretty ModuleName
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods pretty :: ModuleName -> StyleDoc #
type Rep ModuleName
Instance details Defined in Distribution.ModuleName type Rep ModuleName = D1 ('MetaData "ModuleName" "Distribution.ModuleName" "Cabal-3.6.3.0" 'True) (C1 ('MetaCons "ModuleName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortText)))

data CabalFileInfo Source #

How to choose a cabal file for a package from Hackage. This is to work with Hackage cabal file revisions, which makes PackageIdentifier insufficient for specifying a package from Hackage.

Since: 0.1.0.0

Constructors

CFILatest

Take the latest revision of the cabal file available. This isn't reproducible at all, but the running assumption (not necessarily true) is that cabal file revisions do not change semantics of the build.

Since: 0.1.0.0

CFIHash !SHA256 !(Maybe FileSize)

Identify by contents of the cabal file itself. Only reason for Maybe on FileSize is for compatibility with input that doesn't include the file size.

Since: 0.1.0.0

CFIRevision !Revision

Identify by revision number, with 0 being the original and counting upward. This relies on Hackage providing consistent versioning. CFIHash should be preferred wherever possible for reproducibility.

Since: 0.1.0.0

Instances

Instances details

Generic CabalFileInfo Source #
Instance details Defined in Pantry.Types Associated Types type Rep CabalFileInfo :: Type -> Type # Methods from :: CabalFileInfo -> Rep CabalFileInfo x # to :: Rep CabalFileInfo x -> CabalFileInfo #
Show CabalFileInfo Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> CabalFileInfo -> ShowS # show :: CabalFileInfo -> String # showList :: [CabalFileInfo] -> ShowS #
NFData CabalFileInfo Source #
Instance details Defined in Pantry.Types Methods rnf :: CabalFileInfo -> () #
Eq CabalFileInfo Source #
Instance details Defined in Pantry.Types Methods (==) :: CabalFileInfo -> CabalFileInfo -> Bool # (/=) :: CabalFileInfo -> CabalFileInfo -> Bool #
Ord CabalFileInfo Source #
Instance details Defined in Pantry.Types Methods compare :: CabalFileInfo -> CabalFileInfo -> Ordering # (<) :: CabalFileInfo -> CabalFileInfo -> Bool # (<=) :: CabalFileInfo -> CabalFileInfo -> Bool # (>) :: CabalFileInfo -> CabalFileInfo -> Bool # (>=) :: CabalFileInfo -> CabalFileInfo -> Bool # max :: CabalFileInfo -> CabalFileInfo -> CabalFileInfo # min :: CabalFileInfo -> CabalFileInfo -> CabalFileInfo #
Hashable CabalFileInfo Source #
Instance details Defined in Pantry.Types Methods hashWithSalt :: Int -> CabalFileInfo -> Int # hash :: CabalFileInfo -> Int #
Display CabalFileInfo Source #
Instance details Defined in Pantry.Types Methods display :: CabalFileInfo -> Utf8Builder # textDisplay :: CabalFileInfo -> Text #
type Rep CabalFileInfo Source #
Instance details Defined in Pantry.Types type Rep CabalFileInfo = D1 ('MetaData "CabalFileInfo" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "CFILatest" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CFIHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SHA256) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe FileSize))) :+: C1 ('MetaCons "CFIRevision" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Revision))))

data PrintWarnings Source #

Should we print warnings when loading a cabal file?

Since: 0.1.0.0

Constructors

YesPrintWarnings
NoPrintWarnings

newtype PackageNameP Source #

Constructors

PackageNameP
Fields unPackageNameP :: PackageName

Instances

Instances details

FromJSON PackageNameP Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser PackageNameP # parseJSONList :: Value -> Parser [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 #
ToJSONKey PackageNameP Source #
Instance details Defined in Pantry.Types Methods toJSONKey :: ToJSONKeyFunction PackageNameP # toJSONKeyList :: ToJSONKeyFunction [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 #
NFData PackageNameP Source #
Instance details Defined in Pantry.Types Methods rnf :: PackageNameP -> () #
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 #

newtype VersionP Source #

Constructors

VersionP
Fields unVersionP :: Version

Instances

Instances details

FromJSON VersionP Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser VersionP # parseJSONList :: Value -> Parser [VersionP] #
ToJSON VersionP Source #
Instance details Defined in Pantry.Types Methods toJSON :: VersionP -> Value # toEncoding :: VersionP -> Encoding # toJSONList :: [VersionP] -> Value # toEncodingList :: [VersionP] -> Encoding #
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 #
NFData VersionP Source #
Instance details Defined in Pantry.Types Methods rnf :: VersionP -> () #
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 #

newtype ModuleNameP Source #

Constructors

ModuleNameP
Fields unModuleNameP :: ModuleName

Instances

Instances details

Show ModuleNameP Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> ModuleNameP -> ShowS # show :: ModuleNameP -> String # showList :: [ModuleNameP] -> ShowS #
NFData ModuleNameP Source #
Instance details Defined in Pantry.Types Methods rnf :: ModuleNameP -> () #
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 #

data PackageIdentifierRevision Source #

A full specification for a package from Hackage, including the package name, version, and how to load up the correct cabal file revision.

Since: 0.1.0.0

Constructors

PackageIdentifierRevision !PackageName !Version !CabalFileInfo

Instances

Instances details

FromJSON PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser PackageIdentifierRevision # parseJSONList :: Value -> Parser [PackageIdentifierRevision] #
ToJSON PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Methods toJSON :: PackageIdentifierRevision -> Value # toEncoding :: PackageIdentifierRevision -> Encoding # toJSONList :: [PackageIdentifierRevision] -> Value # toEncodingList :: [PackageIdentifierRevision] -> Encoding #
Generic PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Associated Types type Rep PackageIdentifierRevision :: Type -> Type # Methods from :: PackageIdentifierRevision -> Rep PackageIdentifierRevision x # to :: Rep PackageIdentifierRevision x -> PackageIdentifierRevision #
Show PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PackageIdentifierRevision -> ShowS # show :: PackageIdentifierRevision -> String # showList :: [PackageIdentifierRevision] -> ShowS #
NFData PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Methods rnf :: PackageIdentifierRevision -> () #
Eq PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Methods (==) :: PackageIdentifierRevision -> PackageIdentifierRevision -> Bool # (/=) :: PackageIdentifierRevision -> PackageIdentifierRevision -> Bool #
Ord PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Methods compare :: PackageIdentifierRevision -> PackageIdentifierRevision -> Ordering # (<) :: PackageIdentifierRevision -> PackageIdentifierRevision -> Bool # (<=) :: PackageIdentifierRevision -> PackageIdentifierRevision -> Bool # (>) :: PackageIdentifierRevision -> PackageIdentifierRevision -> Bool # (>=) :: PackageIdentifierRevision -> PackageIdentifierRevision -> Bool # max :: PackageIdentifierRevision -> PackageIdentifierRevision -> PackageIdentifierRevision # min :: PackageIdentifierRevision -> PackageIdentifierRevision -> PackageIdentifierRevision #
Display PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types Methods display :: PackageIdentifierRevision -> Utf8Builder # textDisplay :: PackageIdentifierRevision -> Text #
type Rep PackageIdentifierRevision Source #
Instance details Defined in Pantry.Types type Rep PackageIdentifierRevision = D1 ('MetaData "PackageIdentifierRevision" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "PackageIdentifierRevision" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageName) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Version) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CabalFileInfo))))

pirForHash :: PackageIdentifier -> BlobKey -> PackageIdentifierRevision Source #

Package identifier and revision with a specified cabal file hash

Since: 0.1.0.0

data FileType Source #

Constructors

FTNormal
FTExecutable

Instances

Instances details

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 #

data BuildFile Source #

Constructors

BFCabal !SafeFilePath !TreeEntry
BFHpack !TreeEntry

Instances

Instances details

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 #

newtype FileSize Source #

File size in bytes

Since: 0.1.0.0

Constructors

FileSize Word

Instances

Instances details

FromJSON FileSize Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser FileSize # parseJSONList :: Value -> Parser [FileSize] #
ToJSON FileSize Source #
Instance details Defined in Pantry.Types Methods toJSON :: FileSize -> Value # toEncoding :: FileSize -> Encoding # toJSONList :: [FileSize] -> Value # toEncodingList :: [FileSize] -> Encoding #
Generic FileSize Source #
Instance details Defined in Pantry.Types Associated Types type Rep FileSize :: Type -> Type # Methods from :: FileSize -> Rep FileSize x # to :: Rep FileSize x -> FileSize #
Show FileSize Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> FileSize -> ShowS # show :: FileSize -> String # showList :: [FileSize] -> ShowS #
NFData FileSize Source #
Instance details Defined in Pantry.Types Methods rnf :: FileSize -> () #
Eq FileSize Source #
Instance details Defined in Pantry.Types Methods (==) :: FileSize -> FileSize -> Bool # (/=) :: FileSize -> FileSize -> Bool #
Ord FileSize Source #
Instance details Defined in Pantry.Types Methods compare :: FileSize -> FileSize -> Ordering # (<) :: FileSize -> FileSize -> Bool # (<=) :: FileSize -> FileSize -> Bool # (>) :: FileSize -> FileSize -> Bool # (>=) :: FileSize -> FileSize -> Bool # max :: FileSize -> FileSize -> FileSize # min :: FileSize -> FileSize -> FileSize #
Hashable FileSize Source #
Instance details Defined in Pantry.Types Methods hashWithSalt :: Int -> FileSize -> Int # hash :: FileSize -> Int #
PersistField FileSize Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: FileSize -> PersistValue # fromPersistValue :: PersistValue -> Either Text FileSize #
PersistFieldSql FileSize Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy FileSize -> SqlType #
Display FileSize Source #
Instance details Defined in Pantry.Types Methods display :: FileSize -> Utf8Builder # textDisplay :: FileSize -> Text #
type Rep FileSize Source #
Instance details Defined in Pantry.Types type Rep FileSize = D1 ('MetaData "FileSize" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'True) (C1 ('MetaCons "FileSize" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

data TreeEntry Source #

Constructors

TreeEntry
Fields teBlob :: !BlobKey teType :: !FileType

Instances

Instances details

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 #

data SafeFilePath Source #

Instances

Instances details

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 #

unSafeFilePath :: SafeFilePath -> Text Source #

mkSafeFilePath :: Text -> Maybe SafeFilePath Source #

safeFilePathToPath :: MonadThrow m => Path Abs Dir -> SafeFilePath -> m (Path Abs File) Source #

hpackSafeFilePath :: SafeFilePath Source #

SafeFilePath for `package.yaml` file.

newtype TreeKey Source #

The hash of the binary representation of a Tree.

Since: 0.1.0.0

Constructors

TreeKey BlobKey

Instances

Instances details

FromJSON TreeKey Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser TreeKey # parseJSONList :: Value -> Parser [TreeKey] #
ToJSON TreeKey Source #
Instance details Defined in Pantry.Types Methods toJSON :: TreeKey -> Value # toEncoding :: TreeKey -> Encoding # toJSONList :: [TreeKey] -> Value # toEncodingList :: [TreeKey] -> Encoding #
Generic TreeKey Source #
Instance details Defined in Pantry.Types Associated Types type Rep TreeKey :: Type -> Type # Methods from :: TreeKey -> Rep TreeKey x # to :: Rep TreeKey x -> TreeKey #
Show TreeKey Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> TreeKey -> ShowS # show :: TreeKey -> String # showList :: [TreeKey] -> ShowS #
NFData TreeKey Source #
Instance details Defined in Pantry.Types Methods rnf :: TreeKey -> () #
Eq TreeKey Source #
Instance details Defined in Pantry.Types Methods (==) :: TreeKey -> TreeKey -> Bool # (/=) :: TreeKey -> TreeKey -> Bool #
Ord TreeKey Source #
Instance details Defined in Pantry.Types Methods compare :: TreeKey -> TreeKey -> Ordering # (<) :: TreeKey -> TreeKey -> Bool # (<=) :: TreeKey -> TreeKey -> Bool # (>) :: TreeKey -> TreeKey -> Bool # (>=) :: TreeKey -> TreeKey -> Bool # max :: TreeKey -> TreeKey -> TreeKey # min :: TreeKey -> TreeKey -> TreeKey #
Display TreeKey Source #
Instance details Defined in Pantry.Types Methods display :: TreeKey -> Utf8Builder # textDisplay :: TreeKey -> Text #
type Rep TreeKey Source #
Instance details Defined in Pantry.Types type Rep TreeKey = D1 ('MetaData "TreeKey" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'True) (C1 ('MetaCons "TreeKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlobKey)))

newtype Tree Source #

Represents the contents of a tree, which is a mapping from relative file paths to TreeEntrys.

Since: 0.1.0.0

Constructors

TreeMap (Map SafeFilePath TreeEntry)

Instances

Instances details

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 #

renderTree :: Tree -> ByteString Source #

parseTree :: ByteString -> Maybe Tree Source #

parseTreeM :: MonadThrow m => (BlobKey, ByteString) -> m (TreeKey, Tree) Source #

data SHA256 Source #

A SHA256 hash, stored in a static size for more efficient memory representation.

Since: 0.1.0.0

Instances

Instances details

FromJSON SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods parseJSON :: Value -> Parser SHA256 # parseJSONList :: Value -> Parser [SHA256] #
ToJSON SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods toJSON :: SHA256 -> Value # toEncoding :: SHA256 -> Encoding # toJSONList :: [SHA256] -> Value # toEncodingList :: [SHA256] -> Encoding #
Data SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SHA256 -> c SHA256 # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SHA256 # toConstr :: SHA256 -> Constr # dataTypeOf :: SHA256 -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SHA256) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SHA256) # gmapT :: (forall b. Data b => b -> b) -> SHA256 -> SHA256 # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SHA256 -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SHA256 -> r # gmapQ :: (forall d. Data d => d -> u) -> SHA256 -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SHA256 -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SHA256 -> m SHA256 # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SHA256 -> m SHA256 # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SHA256 -> m SHA256 #
Generic SHA256 Source #
Instance details Defined in Pantry.SHA256 Associated Types type Rep SHA256 :: Type -> Type # Methods from :: SHA256 -> Rep SHA256 x # to :: Rep SHA256 x -> SHA256 #
Show SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods showsPrec :: Int -> SHA256 -> ShowS # show :: SHA256 -> String # showList :: [SHA256] -> ShowS #
NFData SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods rnf :: SHA256 -> () #
Eq SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods (==) :: SHA256 -> SHA256 -> Bool # (/=) :: SHA256 -> SHA256 -> Bool #
Ord SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods compare :: SHA256 -> SHA256 -> Ordering # (<) :: SHA256 -> SHA256 -> Bool # (<=) :: SHA256 -> SHA256 -> Bool # (>) :: SHA256 -> SHA256 -> Bool # (>=) :: SHA256 -> SHA256 -> Bool # max :: SHA256 -> SHA256 -> SHA256 # min :: SHA256 -> SHA256 -> SHA256 #
Hashable SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods hashWithSalt :: Int -> SHA256 -> Int # hash :: SHA256 -> Int #
PersistField SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods toPersistValue :: SHA256 -> PersistValue # fromPersistValue :: PersistValue -> Either Text SHA256 #
PersistFieldSql SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods sqlType :: Proxy SHA256 -> SqlType #
Display SHA256 Source #
Instance details Defined in Pantry.SHA256 Methods display :: SHA256 -> Utf8Builder # textDisplay :: SHA256 -> Text #
type Rep SHA256 Source #
Instance details Defined in Pantry.SHA256 type Rep SHA256 = D1 ('MetaData "SHA256" "Pantry.SHA256" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'True) (C1 ('MetaCons "SHA256" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bytes32)))

data Unresolved a Source #

Wraps a value which potentially contains relative paths. Needs to be provided with a base directory to resolve these paths.

Unwrap this using resolvePaths.

Since: 0.1.0.0

Instances

Instances details

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 PackageLocationImmutable)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved PackageLocationImmutable)) # parseJSONList :: Value -> Parser [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)] #
FromJSON (WithJSONWarnings (Unresolved RawSnapshotLocation)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved RawSnapshotLocation)) # parseJSONList :: Value -> Parser [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)] #
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))] #
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))] #

resolvePaths Source #

Arguments

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

Resolve all of the file paths in an Unresolved relative to the given directory.

Since: 0.1.0.0

data Package Source #

Parsed tree with more information on the Haskell package it contains.

Since: 0.1.0.0

Constructors

Package

Fields

packageTreeKey :: !TreeKey
The TreeKey containing this package.
This is a hash of the binary representation of packageTree.
Since: 0.1.0.0
packageTree :: !Tree
The Tree containing this package.
Since: 0.1.0.0
packageCabalEntry :: !PackageCabal
Information on the cabal file inside this package.
Since: 0.1.0.0
packageIdent :: !PackageIdentifier
The package name and version in this package.
Since: 0.1.0.0

Instances

Instances details

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 #

data PackageCabal Source #

Constructors

PCCabalFile !TreeEntry	TreeEntry of Cabal file
PCHpack !PHpack

Instances

Instances details

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 #

data PHpack Source #

Constructors

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

Instances

Instances details

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 #

data RawPackageLocation Source #

Location to load a package from. Can either be immutable (see PackageLocationImmutable) or a local directory which is expected to change over time. Raw version doesn't include exact package version (e.g. could refer to the latest revision on Hackage)

Since: 0.1.0.0

Constructors

RPLImmutable !RawPackageLocationImmutable
RPLMutable !(ResolvedPath Dir)

Instances

Instances details

ToJSON RawPackageLocation Source #
Instance details Defined in Pantry.Types Methods toJSON :: RawPackageLocation -> Value # toEncoding :: RawPackageLocation -> Encoding # toJSONList :: [RawPackageLocation] -> Value # toEncodingList :: [RawPackageLocation] -> Encoding #
Generic RawPackageLocation Source #
Instance details Defined in Pantry.Types Associated Types type Rep RawPackageLocation :: Type -> Type # Methods from :: RawPackageLocation -> Rep RawPackageLocation x # to :: Rep RawPackageLocation x -> RawPackageLocation #
Show RawPackageLocation Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RawPackageLocation -> ShowS # show :: RawPackageLocation -> String # showList :: [RawPackageLocation] -> ShowS #
NFData RawPackageLocation Source #
Instance details Defined in Pantry.Types Methods rnf :: RawPackageLocation -> () #
Eq RawPackageLocation Source #
Instance details Defined in Pantry.Types Methods (==) :: RawPackageLocation -> RawPackageLocation -> Bool # (/=) :: RawPackageLocation -> RawPackageLocation -> Bool #
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))] #
type Rep RawPackageLocation Source #
Instance details Defined in Pantry.Types type Rep RawPackageLocation = D1 ('MetaData "RawPackageLocation" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "RPLImmutable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RawPackageLocationImmutable)) :+: C1 ('MetaCons "RPLMutable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ResolvedPath Dir))))

data PackageLocation Source #

Location to load a package from. Can either be immutable (see PackageLocationImmutable) or a local directory which is expected to change over time.

Since: 0.1.0.0

Constructors

PLImmutable !PackageLocationImmutable
PLMutable !(ResolvedPath Dir)

Instances

Instances details

Generic PackageLocation Source #
Instance details Defined in Pantry.Types Associated Types type Rep PackageLocation :: Type -> Type # Methods from :: PackageLocation -> Rep PackageLocation x # to :: Rep PackageLocation x -> PackageLocation #
Show PackageLocation Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PackageLocation -> ShowS # show :: PackageLocation -> String # showList :: [PackageLocation] -> ShowS #
NFData PackageLocation Source #
Instance details Defined in Pantry.Types Methods rnf :: PackageLocation -> () #
Eq PackageLocation Source #
Instance details Defined in Pantry.Types Methods (==) :: PackageLocation -> PackageLocation -> Bool # (/=) :: PackageLocation -> PackageLocation -> Bool #
Display PackageLocation Source #
Instance details Defined in Pantry.Types Methods display :: PackageLocation -> Utf8Builder # textDisplay :: PackageLocation -> Text #
type Rep PackageLocation Source #
Instance details Defined in Pantry.Types type Rep PackageLocation = D1 ('MetaData "PackageLocation" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "PLImmutable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageLocationImmutable)) :+: C1 ('MetaCons "PLMutable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ResolvedPath Dir))))

toRawPL :: PackageLocation -> RawPackageLocation Source #

Convert PackageLocation to its "raw" equivalent

Since: 0.1.0.0

data RawPackageLocationImmutable Source #

Location for remote packages or archives assumed to be immutable. as user specifies it i.e. not an exact location

Since: 0.1.0.0

Constructors

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

Instances

Instances details

ToJSON RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods toJSON :: RawPackageLocationImmutable -> Value # toEncoding :: RawPackageLocationImmutable -> Encoding # toJSONList :: [RawPackageLocationImmutable] -> Value # toEncodingList :: [RawPackageLocationImmutable] -> Encoding #
Generic RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Associated Types type Rep RawPackageLocationImmutable :: Type -> Type # Methods from :: RawPackageLocationImmutable -> Rep RawPackageLocationImmutable x # to :: Rep RawPackageLocationImmutable x -> RawPackageLocationImmutable #
Show RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RawPackageLocationImmutable -> ShowS # show :: RawPackageLocationImmutable -> String # showList :: [RawPackageLocationImmutable] -> ShowS #
NFData RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods rnf :: RawPackageLocationImmutable -> () #
Eq RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods (==) :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> Bool # (/=) :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> Bool #
Ord RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods compare :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> Ordering # (<) :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> Bool # (<=) :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> Bool # (>) :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> Bool # (>=) :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> Bool # max :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> RawPackageLocationImmutable # min :: RawPackageLocationImmutable -> RawPackageLocationImmutable -> RawPackageLocationImmutable #
Display RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods display :: RawPackageLocationImmutable -> Utf8Builder # textDisplay :: RawPackageLocationImmutable -> Text #
Pretty RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods pretty :: RawPackageLocationImmutable -> StyleDoc #
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))] #
type Rep RawPackageLocationImmutable Source #
Instance details Defined in Pantry.Types type Rep RawPackageLocationImmutable = D1 ('MetaData "RawPackageLocationImmutable" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "RPLIHackage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageIdentifierRevision) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe TreeKey))) :+: (C1 ('MetaCons "RPLIArchive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RawArchive) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RawPackageMetadata)) :+: C1 ('MetaCons "RPLIRepo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Repo) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RawPackageMetadata))))

data PackageLocationImmutable Source #

Location for remote packages or archives assumed to be immutable.

Since: 0.1.0.0

Constructors

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

Instances

Instances details

ToJSON PackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods toJSON :: PackageLocationImmutable -> Value # toEncoding :: PackageLocationImmutable -> Encoding # toJSONList :: [PackageLocationImmutable] -> Value # toEncodingList :: [PackageLocationImmutable] -> Encoding #
Generic PackageLocationImmutable Source #
Instance details Defined in Pantry.Types Associated Types type Rep PackageLocationImmutable :: Type -> Type # Methods from :: PackageLocationImmutable -> Rep PackageLocationImmutable x # to :: Rep PackageLocationImmutable x -> PackageLocationImmutable #
Show PackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PackageLocationImmutable -> ShowS # show :: PackageLocationImmutable -> String # showList :: [PackageLocationImmutable] -> ShowS #
NFData PackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods rnf :: PackageLocationImmutable -> () #
Eq PackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods (==) :: PackageLocationImmutable -> PackageLocationImmutable -> Bool # (/=) :: PackageLocationImmutable -> PackageLocationImmutable -> Bool #
Ord PackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods compare :: PackageLocationImmutable -> PackageLocationImmutable -> Ordering # (<) :: PackageLocationImmutable -> PackageLocationImmutable -> Bool # (<=) :: PackageLocationImmutable -> PackageLocationImmutable -> Bool # (>) :: PackageLocationImmutable -> PackageLocationImmutable -> Bool # (>=) :: PackageLocationImmutable -> PackageLocationImmutable -> Bool # max :: PackageLocationImmutable -> PackageLocationImmutable -> PackageLocationImmutable # min :: PackageLocationImmutable -> PackageLocationImmutable -> PackageLocationImmutable #
Display PackageLocationImmutable Source #
Instance details Defined in Pantry.Types Methods display :: PackageLocationImmutable -> Utf8Builder # textDisplay :: PackageLocationImmutable -> Text #
FromJSON (WithJSONWarnings (Unresolved PackageLocationImmutable)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved PackageLocationImmutable)) # parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved PackageLocationImmutable)] #
type Rep PackageLocationImmutable Source #
Instance details Defined in Pantry.Types type Rep PackageLocationImmutable = D1 ('MetaData "PackageLocationImmutable" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "PLIHackage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageIdentifier) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlobKey) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TreeKey))) :+: (C1 ('MetaCons "PLIArchive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Archive) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageMetadata)) :+: C1 ('MetaCons "PLIRepo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Repo) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageMetadata))))

toRawPLI :: PackageLocationImmutable -> RawPackageLocationImmutable Source #

Convert PackageLocationImmutable to its "raw" equivalent

Since: 0.1.0.0

data RawArchive Source #

A raw package archive, specified by a user, could have no hash and file size information.

Since: 0.1.0.0

Constructors

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

Instances

Instances details

Generic RawArchive Source #
Instance details Defined in Pantry.Types Associated Types type Rep RawArchive :: Type -> Type # Methods from :: RawArchive -> Rep RawArchive x # to :: Rep RawArchive x -> RawArchive #
Show RawArchive Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RawArchive -> ShowS # show :: RawArchive -> String # showList :: [RawArchive] -> ShowS #
NFData RawArchive Source #
Instance details Defined in Pantry.Types Methods rnf :: RawArchive -> () #
Eq RawArchive Source #
Instance details Defined in Pantry.Types Methods (==) :: RawArchive -> RawArchive -> Bool # (/=) :: RawArchive -> RawArchive -> Bool #
Ord RawArchive Source #
Instance details Defined in Pantry.Types Methods compare :: RawArchive -> RawArchive -> Ordering # (<) :: RawArchive -> RawArchive -> Bool # (<=) :: RawArchive -> RawArchive -> Bool # (>) :: RawArchive -> RawArchive -> Bool # (>=) :: RawArchive -> RawArchive -> Bool # max :: RawArchive -> RawArchive -> RawArchive # min :: RawArchive -> RawArchive -> RawArchive #
type Rep RawArchive Source #
Instance details Defined in Pantry.Types type Rep RawArchive = D1 ('MetaData "RawArchive" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "RawArchive" 'PrefixI 'True) ((S1 ('MetaSel ('Just "raLocation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ArchiveLocation) :: S1 ('MetaSel ('Just "raHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe SHA256))) :: (S1 ('MetaSel ('Just "raSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe FileSize)) :*: S1 ('MetaSel ('Just "raSubdir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

data Archive Source #

A package archive, could be from a URL or a local file path. Local file path archives are assumed to be unchanging over time, and so are allowed in custom snapshots.

Since: 0.1.0.0

Constructors

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

Instances

Instances details

Generic Archive Source #
Instance details Defined in Pantry.Types Associated Types type Rep Archive :: Type -> Type # Methods from :: Archive -> Rep Archive x # to :: Rep Archive x -> Archive #
Show Archive Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> Archive -> ShowS # show :: Archive -> String # showList :: [Archive] -> ShowS #
NFData Archive Source #
Instance details Defined in Pantry.Types Methods rnf :: Archive -> () #
Eq Archive Source #
Instance details Defined in Pantry.Types Methods (==) :: Archive -> Archive -> Bool # (/=) :: Archive -> Archive -> Bool #
Ord Archive Source #
Instance details Defined in Pantry.Types Methods compare :: Archive -> Archive -> Ordering # (<) :: Archive -> Archive -> Bool # (<=) :: Archive -> Archive -> Bool # (>) :: Archive -> Archive -> Bool # (>=) :: Archive -> Archive -> Bool # max :: Archive -> Archive -> Archive # min :: Archive -> Archive -> Archive #
type Rep Archive Source #
Instance details Defined in Pantry.Types type Rep Archive = D1 ('MetaData "Archive" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "Archive" 'PrefixI 'True) ((S1 ('MetaSel ('Just "archiveLocation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ArchiveLocation) :: S1 ('MetaSel ('Just "archiveHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SHA256)) :: (S1 ('MetaSel ('Just "archiveSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FileSize) :*: S1 ('MetaSel ('Just "archiveSubdir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

toRawArchive :: Archive -> RawArchive Source #

Convert archive to its "raw" equivalent.

Since: 0.1.0.0

data Repo Source #

Information on packages stored in a source control repository.

Since: 0.1.0.0

Constructors

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

Instances

Instances details

Generic Repo Source #
Instance details Defined in Pantry.Types Associated Types type Rep Repo :: Type -> Type # Methods from :: Repo -> Rep Repo x # to :: Rep Repo x -> Repo #
Show Repo Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> Repo -> ShowS # show :: Repo -> String # showList :: [Repo] -> ShowS #
NFData Repo Source #
Instance details Defined in Pantry.Types Methods rnf :: Repo -> () #
Eq Repo Source #
Instance details Defined in Pantry.Types Methods (==) :: Repo -> Repo -> Bool # (/=) :: Repo -> Repo -> Bool #
Ord Repo Source #
Instance details Defined in Pantry.Types Methods compare :: Repo -> Repo -> Ordering # (<) :: Repo -> Repo -> Bool # (<=) :: Repo -> Repo -> Bool # (>) :: Repo -> Repo -> Bool # (>=) :: Repo -> Repo -> Bool # max :: Repo -> Repo -> Repo # min :: Repo -> Repo -> Repo #
Display Repo Source #
Instance details Defined in Pantry.Types Methods display :: Repo -> Utf8Builder # textDisplay :: Repo -> Text #
type Rep Repo Source #
Instance details Defined in Pantry.Types type Rep Repo = D1 ('MetaData "Repo" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "Repo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "repoUrl") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "repoCommit") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "repoType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RepoType) :*: S1 ('MetaSel ('Just "repoSubdir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

data AggregateRepo Source #

Constructors

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

Instances

Instances details

Generic AggregateRepo Source #
Instance details Defined in Pantry.Types Associated Types type Rep AggregateRepo :: Type -> Type # Methods from :: AggregateRepo -> Rep AggregateRepo x # to :: Rep AggregateRepo x -> AggregateRepo #
Show AggregateRepo Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> AggregateRepo -> ShowS # show :: AggregateRepo -> String # showList :: [AggregateRepo] -> ShowS #
Eq AggregateRepo Source #
Instance details Defined in Pantry.Types Methods (==) :: AggregateRepo -> AggregateRepo -> Bool # (/=) :: AggregateRepo -> AggregateRepo -> Bool #
Ord AggregateRepo Source #
Instance details Defined in Pantry.Types Methods compare :: AggregateRepo -> AggregateRepo -> Ordering # (<) :: AggregateRepo -> AggregateRepo -> Bool # (<=) :: AggregateRepo -> AggregateRepo -> Bool # (>) :: AggregateRepo -> AggregateRepo -> Bool # (>=) :: AggregateRepo -> AggregateRepo -> Bool # max :: AggregateRepo -> AggregateRepo -> AggregateRepo # min :: AggregateRepo -> AggregateRepo -> AggregateRepo #
type Rep AggregateRepo Source #
Instance details Defined in Pantry.Types type Rep AggregateRepo = D1 ('MetaData "AggregateRepo" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "AggregateRepo" 'PrefixI 'True) (S1 ('MetaSel ('Just "aRepo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SimpleRepo) :*: S1 ('MetaSel ('Just "aRepoSubdirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, RawPackageMetadata)])))

data SimpleRepo Source #

Repository without subdirectory information.

Since: 0.5.3

Constructors

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

Instances

Instances details

Generic SimpleRepo Source #
Instance details Defined in Pantry.Types Associated Types type Rep SimpleRepo :: Type -> Type # Methods from :: SimpleRepo -> Rep SimpleRepo x # to :: Rep SimpleRepo x -> SimpleRepo #
Show SimpleRepo Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> SimpleRepo -> ShowS # show :: SimpleRepo -> String # showList :: [SimpleRepo] -> ShowS #
Eq SimpleRepo Source #
Instance details Defined in Pantry.Types Methods (==) :: SimpleRepo -> SimpleRepo -> Bool # (/=) :: SimpleRepo -> SimpleRepo -> Bool #
Ord SimpleRepo Source #
Instance details Defined in Pantry.Types Methods compare :: SimpleRepo -> SimpleRepo -> Ordering # (<) :: SimpleRepo -> SimpleRepo -> Bool # (<=) :: SimpleRepo -> SimpleRepo -> Bool # (>) :: SimpleRepo -> SimpleRepo -> Bool # (>=) :: SimpleRepo -> SimpleRepo -> Bool # max :: SimpleRepo -> SimpleRepo -> SimpleRepo # min :: SimpleRepo -> SimpleRepo -> SimpleRepo #
Display SimpleRepo Source #
Instance details Defined in Pantry.Types Methods display :: SimpleRepo -> Utf8Builder # textDisplay :: SimpleRepo -> Text #
type Rep SimpleRepo Source #
Instance details Defined in Pantry.Types type Rep SimpleRepo = D1 ('MetaData "SimpleRepo" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "SimpleRepo" 'PrefixI 'True) (S1 ('MetaSel ('Just "sRepoUrl") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sRepoCommit") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sRepoType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RepoType))))

toAggregateRepos :: [(Repo, RawPackageMetadata)] -> [AggregateRepo] Source #

Group input repositories by non-subdir values.

rToSimpleRepo :: Repo -> SimpleRepo Source #

arToSimpleRepo :: AggregateRepo -> SimpleRepo Source #

data RepoType Source #

The type of a source control repository.

Since: 0.1.0.0

Constructors

RepoGit
RepoHg

Instances

Instances details

Generic RepoType Source #
Instance details Defined in Pantry.Types Associated Types type Rep RepoType :: Type -> Type # Methods from :: RepoType -> Rep RepoType x # to :: Rep RepoType x -> RepoType #
Show RepoType Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RepoType -> ShowS # show :: RepoType -> String # showList :: [RepoType] -> ShowS #
NFData RepoType Source #
Instance details Defined in Pantry.Types Methods rnf :: RepoType -> () #
Eq RepoType Source #
Instance details Defined in Pantry.Types Methods (==) :: RepoType -> RepoType -> Bool # (/=) :: RepoType -> RepoType -> Bool #
Ord RepoType Source #
Instance details Defined in Pantry.Types Methods compare :: RepoType -> RepoType -> Ordering # (<) :: RepoType -> RepoType -> Bool # (<=) :: RepoType -> RepoType -> Bool # (>) :: RepoType -> RepoType -> Bool # (>=) :: RepoType -> RepoType -> Bool # max :: RepoType -> RepoType -> RepoType # min :: RepoType -> RepoType -> RepoType #
PersistField RepoType Source #
Instance details Defined in Pantry.Types Methods toPersistValue :: RepoType -> PersistValue # fromPersistValue :: PersistValue -> Either Text RepoType #
PersistFieldSql RepoType Source #
Instance details Defined in Pantry.Types Methods sqlType :: Proxy RepoType -> SqlType #
type Rep RepoType Source #
Instance details Defined in Pantry.Types type Rep RepoType = D1 ('MetaData "RepoType" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "RepoGit" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RepoHg" 'PrefixI 'False) (U1 :: Type -> Type))

parsePackageIdentifier :: String -> Maybe PackageIdentifier Source #

This is almost a copy of Cabal's parser for package identifiers, the main difference is in the fact that Stack requires version to be present while Cabal uses "null version" as a default value

Since: 0.1.0.0

parsePackageName :: String -> Maybe PackageName Source #

Parse a package name from a Value.

Since: 0.1.0.0

parsePackageNameThrowing :: MonadThrow m => String -> m PackageName Source #

Parse a package name from a Value throwing on failure

Since: 0.1.0.0

parseFlagName :: String -> Maybe FlagName Source #

Parse a flag name from a Value.

Since: 0.1.0.0

parseVersion :: String -> Maybe Version Source #

Parse a version from a Value.

Since: 0.1.0.0

parseVersionThrowing :: MonadThrow m => String -> m Version Source #

Parse a package version from a Value throwing on failure

Since: 0.1.0.0

packageIdentifierString :: PackageIdentifier -> String Source #

Render a package identifier as a Value.

Since: 0.1.0.0

packageNameString :: PackageName -> String Source #

Render a package name as a Value.

Since: 0.1.0.0

flagNameString :: FlagName -> String Source #

Render a flag name as a Value.

Since: 0.1.0.0

versionString :: Version -> String Source #

Render a version as a Value.

Since: 0.1.0.0

moduleNameString :: ModuleName -> String Source #

Render a module name as a Value.

Since: 0.1.0.0

data OptionalSubdirs Source #

Constructors

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

Instances

Instances details

Generic OptionalSubdirs Source #
Instance details Defined in Pantry.Types Associated Types type Rep OptionalSubdirs :: Type -> Type # Methods from :: OptionalSubdirs -> Rep OptionalSubdirs x # to :: Rep OptionalSubdirs x -> OptionalSubdirs #
Show OptionalSubdirs Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> OptionalSubdirs -> ShowS # show :: OptionalSubdirs -> String # showList :: [OptionalSubdirs] -> ShowS #
NFData OptionalSubdirs Source #
Instance details Defined in Pantry.Types Methods rnf :: OptionalSubdirs -> () #
Eq OptionalSubdirs Source #
Instance details Defined in Pantry.Types Methods (==) :: OptionalSubdirs -> OptionalSubdirs -> Bool # (/=) :: OptionalSubdirs -> OptionalSubdirs -> Bool #
type Rep OptionalSubdirs Source #
Instance details Defined in Pantry.Types type Rep OptionalSubdirs = D1 ('MetaData "OptionalSubdirs" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "OSSubdirs" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty Text))) :+: C1 ('MetaCons "OSPackageMetadata" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RawPackageMetadata)))

data ArchiveLocation Source #

Location that an archive is stored at

Since: 0.1.0.0

Constructors

ALUrl !Text

Archive stored at an HTTP(S) URL

Since: 0.1.0.0

ALFilePath !(ResolvedPath File)

Archive stored at a local file path

Since: 0.1.0.0

Instances

Instances details

Generic ArchiveLocation Source #
Instance details Defined in Pantry.Types Associated Types type Rep ArchiveLocation :: Type -> Type # Methods from :: ArchiveLocation -> Rep ArchiveLocation x # to :: Rep ArchiveLocation x -> ArchiveLocation #
Show ArchiveLocation Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> ArchiveLocation -> ShowS # show :: ArchiveLocation -> String # showList :: [ArchiveLocation] -> ShowS #
NFData ArchiveLocation Source #
Instance details Defined in Pantry.Types Methods rnf :: ArchiveLocation -> () #
Eq ArchiveLocation Source #
Instance details Defined in Pantry.Types Methods (==) :: ArchiveLocation -> ArchiveLocation -> Bool # (/=) :: ArchiveLocation -> ArchiveLocation -> Bool #
Ord ArchiveLocation Source #
Instance details Defined in Pantry.Types Methods compare :: ArchiveLocation -> ArchiveLocation -> Ordering # (<) :: ArchiveLocation -> ArchiveLocation -> Bool # (<=) :: ArchiveLocation -> ArchiveLocation -> Bool # (>) :: ArchiveLocation -> ArchiveLocation -> Bool # (>=) :: ArchiveLocation -> ArchiveLocation -> Bool # max :: ArchiveLocation -> ArchiveLocation -> ArchiveLocation # min :: ArchiveLocation -> ArchiveLocation -> ArchiveLocation #
Display ArchiveLocation Source #
Instance details Defined in Pantry.Types Methods display :: ArchiveLocation -> Utf8Builder # textDisplay :: ArchiveLocation -> Text #
Pretty ArchiveLocation Source #
Instance details Defined in Pantry.Types Methods pretty :: ArchiveLocation -> StyleDoc #
type Rep ArchiveLocation Source #
Instance details Defined in Pantry.Types type Rep ArchiveLocation = D1 ('MetaData "ArchiveLocation" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "ALUrl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "ALFilePath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ResolvedPath File))))

newtype RelFilePath Source #

File path relative to the configuration file it was parsed from

Since: 0.1.0.0

Constructors

RelFilePath Text

Instances

Instances details

FromJSON RelFilePath Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser RelFilePath # parseJSONList :: Value -> Parser [RelFilePath] #
ToJSON RelFilePath Source #
Instance details Defined in Pantry.Types Methods toJSON :: RelFilePath -> Value # toEncoding :: RelFilePath -> Encoding # toJSONList :: [RelFilePath] -> Value # toEncodingList :: [RelFilePath] -> Encoding #
Generic RelFilePath Source #
Instance details Defined in Pantry.Types Associated Types type Rep RelFilePath :: Type -> Type # Methods from :: RelFilePath -> Rep RelFilePath x # to :: Rep RelFilePath x -> RelFilePath #
Show RelFilePath Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RelFilePath -> ShowS # show :: RelFilePath -> String # showList :: [RelFilePath] -> ShowS #
NFData RelFilePath Source #
Instance details Defined in Pantry.Types Methods rnf :: RelFilePath -> () #
Eq RelFilePath Source #
Instance details Defined in Pantry.Types Methods (==) :: RelFilePath -> RelFilePath -> Bool # (/=) :: RelFilePath -> RelFilePath -> Bool #
Ord RelFilePath Source #
Instance details Defined in Pantry.Types Methods compare :: RelFilePath -> RelFilePath -> Ordering # (<) :: RelFilePath -> RelFilePath -> Bool # (<=) :: RelFilePath -> RelFilePath -> Bool # (>) :: RelFilePath -> RelFilePath -> Bool # (>=) :: RelFilePath -> RelFilePath -> Bool # max :: RelFilePath -> RelFilePath -> RelFilePath # min :: RelFilePath -> RelFilePath -> RelFilePath #
Display RelFilePath Source #
Instance details Defined in Pantry.Types Methods display :: RelFilePath -> Utf8Builder # textDisplay :: RelFilePath -> Text #
type Rep RelFilePath Source #
Instance details Defined in Pantry.Types type Rep RelFilePath = D1 ('MetaData "RelFilePath" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'True) (C1 ('MetaCons "RelFilePath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype CabalString a Source #

Newtype wrapper for easier JSON integration with Cabal types.

Since: 0.1.0.0

Constructors

CabalString
Fields unCabalString :: a

Instances

Instances details

IsCabalString a => FromJSON (CabalString a) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (CabalString a) # parseJSONList :: Value -> Parser [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 #
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 #

toCabalStringMap :: Map a v -> Map (CabalString a) v Source #

Wrap the keys in a Map with a CabalString to get a ToJSON instance.

Since: 0.1.0.0

unCabalStringMap :: Map (CabalString a) v -> Map a v Source #

Unwrap the CabalString from the keys in a Map to use a FromJSON instance.

Since: 0.1.0.0

parsePackageIdentifierRevision :: Text -> Either PantryException PackageIdentifierRevision Source #

Parse a PackageIdentifierRevision

Since: 0.1.0.0

data Mismatch a Source #

Constructors

Mismatch
Fields mismatchExpected :: !a mismatchActual :: !a

data PantryException Source #

Things that can go wrong in pantry. Note two things:

Many other exception types may be thrown from underlying libraries. Pantry does not attempt to wrap these underlying exceptions.
We may add more constructors to this data type in minor version bumps of pantry. This technically breaks the PVP. You should not be writing pattern matches against this type that expect total matching.

Since: 0.1.0.0

Constructors

PackageIdentifierRevisionParseFail !Text
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
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.
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

Instances

Instances details

Exception PantryException Source #
Instance details Defined in Pantry.Types Methods toException :: PantryException -> SomeException # fromException :: SomeException -> Maybe PantryException # displayException :: PantryException -> String #
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 #

data FuzzyResults Source #

Constructors

FRNameNotFound ![PackageName]
FRVersionNotFound !(NonEmpty PackageIdentifierRevision)
FRRevisionNotFound !(NonEmpty PackageIdentifierRevision)

data ResolvedPath t Source #

A combination of the relative path provided in a config file, together with the resolved absolute path.

Since: 0.1.0.0

Constructors

ResolvedPath
Fields resolvedRelative :: !RelFilePath Original value parsed from a config file. resolvedAbsolute :: !(Path Abs t) Absolute path resolved against base directory loaded from.

Instances

Instances details

Generic (ResolvedPath t) Source #
Instance details Defined in Pantry.Types Associated Types type Rep (ResolvedPath t) :: Type -> Type # Methods from :: ResolvedPath t -> Rep (ResolvedPath t) x # to :: Rep (ResolvedPath t) x -> ResolvedPath t #
Show (ResolvedPath t) Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> ResolvedPath t -> ShowS # show :: ResolvedPath t -> String # showList :: [ResolvedPath t] -> ShowS #
NFData (ResolvedPath t) Source #
Instance details Defined in Pantry.Types Methods rnf :: ResolvedPath t -> () #
Eq (ResolvedPath t) Source #
Instance details Defined in Pantry.Types Methods (==) :: ResolvedPath t -> ResolvedPath t -> Bool # (/=) :: ResolvedPath t -> ResolvedPath t -> Bool #
Ord (ResolvedPath t) Source #
Instance details Defined in Pantry.Types Methods compare :: ResolvedPath t -> ResolvedPath t -> Ordering # (<) :: ResolvedPath t -> ResolvedPath t -> Bool # (<=) :: ResolvedPath t -> ResolvedPath t -> Bool # (>) :: ResolvedPath t -> ResolvedPath t -> Bool # (>=) :: ResolvedPath t -> ResolvedPath t -> Bool # max :: ResolvedPath t -> ResolvedPath t -> ResolvedPath t # min :: ResolvedPath t -> ResolvedPath t -> ResolvedPath t #
type Rep (ResolvedPath t) Source #
Instance details Defined in Pantry.Types type Rep (ResolvedPath t) = D1 ('MetaData "ResolvedPath" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "ResolvedPath" 'PrefixI 'True) (S1 ('MetaSel ('Just "resolvedRelative") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RelFilePath) :*: S1 ('MetaSel ('Just "resolvedAbsolute") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Path Abs t))))

data HpackExecutable Source #

What to use for running hpack

Since: 0.1.0.0

Constructors

HpackBundled	Compiled in library
HpackCommand !FilePath	Executable at the provided path

Instances

Instances details

Read HpackExecutable Source #
Instance details Defined in Pantry.Types Methods readsPrec :: Int -> ReadS HpackExecutable # readList :: ReadS [HpackExecutable] # readPrec :: ReadPrec HpackExecutable # readListPrec :: ReadPrec [HpackExecutable] #
Show HpackExecutable Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> HpackExecutable -> ShowS # show :: HpackExecutable -> String # showList :: [HpackExecutable] -> ShowS #
Eq HpackExecutable Source #
Instance details Defined in Pantry.Types Methods (==) :: HpackExecutable -> HpackExecutable -> Bool # (/=) :: HpackExecutable -> HpackExecutable -> Bool #
Ord HpackExecutable Source #
Instance details Defined in Pantry.Types Methods compare :: HpackExecutable -> HpackExecutable -> Ordering # (<) :: HpackExecutable -> HpackExecutable -> Bool # (<=) :: HpackExecutable -> HpackExecutable -> Bool # (>) :: HpackExecutable -> HpackExecutable -> Bool # (>=) :: HpackExecutable -> HpackExecutable -> Bool # max :: HpackExecutable -> HpackExecutable -> HpackExecutable # min :: HpackExecutable -> HpackExecutable -> HpackExecutable #

data WantedCompiler Source #

Which compiler a snapshot wants to use. The build tool may elect to do some fuzzy matching of versions (e.g., allowing different patch versions).

Since: 0.1.0.0

Constructors

WCGhc !Version
WCGhcGit !Text !Text
WCGhcjs !Version !Version	GHCJS version followed by GHC version

Instances

Instances details

FromJSON WantedCompiler Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser WantedCompiler # parseJSONList :: Value -> Parser [WantedCompiler] #
FromJSONKey WantedCompiler Source #
Instance details Defined in Pantry.Types Methods fromJSONKey :: FromJSONKeyFunction WantedCompiler # fromJSONKeyList :: FromJSONKeyFunction [WantedCompiler] #
ToJSON WantedCompiler Source #
Instance details Defined in Pantry.Types Methods toJSON :: WantedCompiler -> Value # toEncoding :: WantedCompiler -> Encoding # toJSONList :: [WantedCompiler] -> Value # toEncodingList :: [WantedCompiler] -> Encoding #
Generic WantedCompiler Source #
Instance details Defined in Pantry.Types Associated Types type Rep WantedCompiler :: Type -> Type # Methods from :: WantedCompiler -> Rep WantedCompiler x # to :: Rep WantedCompiler x -> WantedCompiler #
Show WantedCompiler Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> WantedCompiler -> ShowS # show :: WantedCompiler -> String # showList :: [WantedCompiler] -> ShowS #
NFData WantedCompiler Source #
Instance details Defined in Pantry.Types Methods rnf :: WantedCompiler -> () #
Eq WantedCompiler Source #
Instance details Defined in Pantry.Types Methods (==) :: WantedCompiler -> WantedCompiler -> Bool # (/=) :: WantedCompiler -> WantedCompiler -> Bool #
Ord WantedCompiler Source #
Instance details Defined in Pantry.Types Methods compare :: WantedCompiler -> WantedCompiler -> Ordering # (<) :: WantedCompiler -> WantedCompiler -> Bool # (<=) :: WantedCompiler -> WantedCompiler -> Bool # (>) :: WantedCompiler -> WantedCompiler -> Bool # (>=) :: WantedCompiler -> WantedCompiler -> Bool # max :: WantedCompiler -> WantedCompiler -> WantedCompiler # min :: WantedCompiler -> WantedCompiler -> WantedCompiler #
Display WantedCompiler Source #
Instance details Defined in Pantry.Types Methods display :: WantedCompiler -> Utf8Builder # textDisplay :: WantedCompiler -> Text #
type Rep WantedCompiler Source #
Instance details Defined in Pantry.Types type Rep WantedCompiler = D1 ('MetaData "WantedCompiler" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "WCGhc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Version)) :+: (C1 ('MetaCons "WCGhcGit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "WCGhcjs" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Version) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Version))))

snapshotLocation :: HasPantryConfig env => SnapName -> RIO env RawSnapshotLocation Source #

Get the location of a snapshot synonym from the PantryConfig.

Since: 0.5.0.0

defaultSnapshotLocation :: SnapName -> RawSnapshotLocation Source #

Default location of snapshot synonyms, i.e. commercialhaskell's GitHub repository.

Since: 0.5.0.0

data SnapName Source #

A snapshot synonym. It is expanded according to the field snapshotLocation of a PantryConfig.

@ since 0.5.0.0

Constructors

LTS

Fields

!Int
Major version
!Int
Minor version ^ LTS Haskell snapshot, displayed as "lts-maj.min".
Since: 0.5.0.0

Nightly !Day

Stackage Nightly snapshot, displayed as "nighly-YYYY-MM-DD".

Since: 0.5.0.0

Instances

Instances details

ToJSON SnapName Source #
Instance details Defined in Pantry.Types Methods toJSON :: SnapName -> Value # toEncoding :: SnapName -> Encoding # toJSONList :: [SnapName] -> Value # toEncodingList :: [SnapName] -> Encoding #
Generic SnapName Source #
Instance details Defined in Pantry.Types Associated Types type Rep SnapName :: Type -> Type # Methods from :: SnapName -> Rep SnapName x # to :: Rep SnapName x -> SnapName #
Show SnapName Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> SnapName -> ShowS # show :: SnapName -> String # showList :: [SnapName] -> ShowS #
NFData SnapName Source #
Instance details Defined in Pantry.Types Methods rnf :: SnapName -> () #
Eq SnapName Source #
Instance details Defined in Pantry.Types Methods (==) :: SnapName -> SnapName -> Bool # (/=) :: SnapName -> SnapName -> Bool #
Ord SnapName Source #
Instance details Defined in Pantry.Types Methods compare :: SnapName -> SnapName -> Ordering # (<) :: SnapName -> SnapName -> Bool # (<=) :: SnapName -> SnapName -> Bool # (>) :: SnapName -> SnapName -> Bool # (>=) :: SnapName -> SnapName -> Bool # max :: SnapName -> SnapName -> SnapName # min :: SnapName -> SnapName -> SnapName #
Display SnapName Source #
Instance details Defined in Pantry.Types Methods display :: SnapName -> Utf8Builder # textDisplay :: SnapName -> Text #
type Rep SnapName Source #
Instance details Defined in Pantry.Types type Rep SnapName = D1 ('MetaData "SnapName" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "LTS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "Nightly" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Day)))

parseSnapName :: MonadThrow m => Text -> m SnapName Source #

Parse the short representation of a SnapName.

Since: 0.5.0.0

data RawSnapshotLocation Source #

Where to load a snapshot from in raw form (RSUrl could have a missing BlobKey)

Since: 0.1.0.0

Constructors

RSLCompiler !WantedCompiler	Don't use an actual snapshot, just a version of the compiler with its shipped packages. Since: 0.1.0.0
RSLUrl !Text !(Maybe BlobKey)	Download the snapshot from the given URL. The optional `BlobKey` is used for reproducibility. Since: 0.1.0.0
RSLFilePath !(ResolvedPath File)	Snapshot at a local file path. Since: 0.1.0.0
RSLSynonym !SnapName	Snapshot synonym (LTS/Nightly). Since: 0.5.0.0

Instances

Instances details

ToJSON RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Methods toJSON :: RawSnapshotLocation -> Value # toEncoding :: RawSnapshotLocation -> Encoding # toJSONList :: [RawSnapshotLocation] -> Value # toEncodingList :: [RawSnapshotLocation] -> Encoding #
Generic RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Associated Types type Rep RawSnapshotLocation :: Type -> Type # Methods from :: RawSnapshotLocation -> Rep RawSnapshotLocation x # to :: Rep RawSnapshotLocation x -> RawSnapshotLocation #
Show RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RawSnapshotLocation -> ShowS # show :: RawSnapshotLocation -> String # showList :: [RawSnapshotLocation] -> ShowS #
NFData RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Methods rnf :: RawSnapshotLocation -> () #
Eq RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Methods (==) :: RawSnapshotLocation -> RawSnapshotLocation -> Bool # (/=) :: RawSnapshotLocation -> RawSnapshotLocation -> Bool #
Ord RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Methods compare :: RawSnapshotLocation -> RawSnapshotLocation -> Ordering # (<) :: RawSnapshotLocation -> RawSnapshotLocation -> Bool # (<=) :: RawSnapshotLocation -> RawSnapshotLocation -> Bool # (>) :: RawSnapshotLocation -> RawSnapshotLocation -> Bool # (>=) :: RawSnapshotLocation -> RawSnapshotLocation -> Bool # max :: RawSnapshotLocation -> RawSnapshotLocation -> RawSnapshotLocation # min :: RawSnapshotLocation -> RawSnapshotLocation -> RawSnapshotLocation #
Display RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Methods display :: RawSnapshotLocation -> Utf8Builder # textDisplay :: RawSnapshotLocation -> Text #
Pretty RawSnapshotLocation Source #
Instance details Defined in Pantry.Types Methods pretty :: RawSnapshotLocation -> StyleDoc #
FromJSON (WithJSONWarnings (Unresolved RawSnapshotLocation)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved RawSnapshotLocation)) # parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved RawSnapshotLocation)] #
type Rep RawSnapshotLocation Source #
Instance details Defined in Pantry.Types type Rep RawSnapshotLocation = D1 ('MetaData "RawSnapshotLocation" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) ((C1 ('MetaCons "RSLCompiler" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 WantedCompiler)) :+: C1 ('MetaCons "RSLUrl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe BlobKey)))) :+: (C1 ('MetaCons "RSLFilePath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ResolvedPath File))) :+: C1 ('MetaCons "RSLSynonym" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SnapName))))

data SnapshotLocation Source #

Where to load a snapshot from.

Since: 0.1.0.0

Constructors

SLCompiler !WantedCompiler

Don't use an actual snapshot, just a version of the compiler with its shipped packages.

Since: 0.1.0.0

SLUrl !Text !BlobKey

Download the snapshot from the given URL. The optional BlobKey is used for reproducibility.

Since: 0.1.0.0

SLFilePath !(ResolvedPath File)

Snapshot at a local file path.

Since: 0.1.0.0

Instances

Instances details

ToJSON SnapshotLocation Source #
Instance details Defined in Pantry.Types Methods toJSON :: SnapshotLocation -> Value # toEncoding :: SnapshotLocation -> Encoding # toJSONList :: [SnapshotLocation] -> Value # toEncodingList :: [SnapshotLocation] -> Encoding #
Generic SnapshotLocation Source #
Instance details Defined in Pantry.Types Associated Types type Rep SnapshotLocation :: Type -> Type # Methods from :: SnapshotLocation -> Rep SnapshotLocation x # to :: Rep SnapshotLocation x -> SnapshotLocation #
Show SnapshotLocation Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> SnapshotLocation -> ShowS # show :: SnapshotLocation -> String # showList :: [SnapshotLocation] -> ShowS #
NFData SnapshotLocation Source #
Instance details Defined in Pantry.Types Methods rnf :: SnapshotLocation -> () #
Eq SnapshotLocation Source #
Instance details Defined in Pantry.Types Methods (==) :: SnapshotLocation -> SnapshotLocation -> Bool # (/=) :: SnapshotLocation -> SnapshotLocation -> Bool #
Ord SnapshotLocation Source #
Instance details Defined in Pantry.Types Methods compare :: SnapshotLocation -> SnapshotLocation -> Ordering # (<) :: SnapshotLocation -> SnapshotLocation -> Bool # (<=) :: SnapshotLocation -> SnapshotLocation -> Bool # (>) :: SnapshotLocation -> SnapshotLocation -> Bool # (>=) :: SnapshotLocation -> SnapshotLocation -> Bool # max :: SnapshotLocation -> SnapshotLocation -> SnapshotLocation # min :: SnapshotLocation -> SnapshotLocation -> SnapshotLocation #
Display SnapshotLocation Source #
Instance details Defined in Pantry.Types Methods display :: SnapshotLocation -> Utf8Builder # textDisplay :: SnapshotLocation -> Text #
FromJSON (WithJSONWarnings (Unresolved SnapshotLocation)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved SnapshotLocation)) # parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved SnapshotLocation)] #
type Rep SnapshotLocation Source #
Instance details Defined in Pantry.Types type Rep SnapshotLocation = D1 ('MetaData "SnapshotLocation" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "SLCompiler" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 WantedCompiler)) :+: (C1 ('MetaCons "SLUrl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlobKey)) :+: C1 ('MetaCons "SLFilePath" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ResolvedPath File)))))

toRawSL :: SnapshotLocation -> RawSnapshotLocation Source #

Convert snapshot location to its "raw" equivalent.

Since: 0.1.0.0

parseHackageText :: Text -> Either PantryException (PackageIdentifier, BlobKey) Source #

Parse a hackage text.

Since: 0.1.0.0

parseRawSnapshotLocation :: Text -> Unresolved RawSnapshotLocation Source #

Parse a Text into an Unresolved RawSnapshotLocation.

Since: 0.1.0.0

data RawSnapshotLayer Source #

A single layer of a snapshot, i.e. a specific YAML configuration file.

Since: 0.1.0.0

Constructors

RawSnapshotLayer

Fields

rslParent :: !RawSnapshotLocation
The sl to extend from. This is either a specific compiler, or a SnapshotLocation which gives us more information (like packages). Ultimately, we'll end up with a CompilerVersion.
Since: 0.1.0.0
rslCompiler :: !(Maybe WantedCompiler)
Override the compiler specified in slParent. Must be Nothing if using SLCompiler.
Since: 0.1.0.0
rslLocations :: ![RawPackageLocationImmutable]
Where to grab all of the packages from.
Since: 0.1.0.0
rslDropPackages :: !(Set PackageName)
Packages present in the parent which should not be included here.
Since: 0.1.0.0
rslFlags :: !(Map PackageName (Map FlagName Bool))
Flag values to override from the defaults
Since: 0.1.0.0
rslHidden :: !(Map PackageName Bool)
Packages which should be hidden when registering. This will affect, for example, the import parser in the script command. We use a Map instead of just a Set to allow overriding the hidden settings in a parent sl.
Since: 0.1.0.0
rslGhcOptions :: !(Map PackageName [Text])
GHC options per package
Since: 0.1.0.0
rslPublishTime :: !(Maybe UTCTime)
See slPublishTime
Since: 0.1.0.0

Instances

Instances details

ToJSON RawSnapshotLayer Source #
Instance details Defined in Pantry.Types Methods toJSON :: RawSnapshotLayer -> Value # toEncoding :: RawSnapshotLayer -> Encoding # toJSONList :: [RawSnapshotLayer] -> Value # toEncodingList :: [RawSnapshotLayer] -> Encoding #
Generic RawSnapshotLayer Source #
Instance details Defined in Pantry.Types Associated Types type Rep RawSnapshotLayer :: Type -> Type # Methods from :: RawSnapshotLayer -> Rep RawSnapshotLayer x # to :: Rep RawSnapshotLayer x -> RawSnapshotLayer #
Show RawSnapshotLayer Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RawSnapshotLayer -> ShowS # show :: RawSnapshotLayer -> String # showList :: [RawSnapshotLayer] -> ShowS #
NFData RawSnapshotLayer Source #
Instance details Defined in Pantry.Types Methods rnf :: RawSnapshotLayer -> () #
Eq RawSnapshotLayer Source #
Instance details Defined in Pantry.Types Methods (==) :: RawSnapshotLayer -> RawSnapshotLayer -> Bool # (/=) :: RawSnapshotLayer -> RawSnapshotLayer -> Bool #
FromJSON (WithJSONWarnings (Unresolved RawSnapshotLayer)) Source #
Instance details Defined in Pantry.Types Methods parseJSON :: Value -> Parser (WithJSONWarnings (Unresolved RawSnapshotLayer)) # parseJSONList :: Value -> Parser [WithJSONWarnings (Unresolved RawSnapshotLayer)] #
type Rep RawSnapshotLayer Source #
Instance details Defined in Pantry.Types type Rep RawSnapshotLayer = D1 ('MetaData "RawSnapshotLayer" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "RawSnapshotLayer" 'PrefixI 'True) (((S1 ('MetaSel ('Just "rslParent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RawSnapshotLocation) :: S1 ('MetaSel ('Just "rslCompiler") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe WantedCompiler))) :: (S1 ('MetaSel ('Just "rslLocations") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [RawPackageLocationImmutable]) :: S1 ('MetaSel ('Just "rslDropPackages") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set PackageName)))) :: ((S1 ('MetaSel ('Just "rslFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName (Map FlagName Bool))) :: S1 ('MetaSel ('Just "rslHidden") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName Bool))) :: (S1 ('MetaSel ('Just "rslGhcOptions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName [Text])) :*: S1 ('MetaSel ('Just "rslPublishTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UTCTime))))))

data SnapshotLayer Source #

A single layer of a snapshot, i.e. a specific YAML configuration file.

Since: 0.1.0.0

Constructors

SnapshotLayer

Fields

slParent :: !SnapshotLocation
The sl to extend from. This is either a specific compiler, or a SnapshotLocation which gives us more information (like packages). Ultimately, we'll end up with a CompilerVersion.
Since: 0.1.0.0
slCompiler :: !(Maybe WantedCompiler)
Override the compiler specified in slParent. Must be Nothing if using SLCompiler.
Since: 0.1.0.0
slLocations :: ![PackageLocationImmutable]
Where to grab all of the packages from.
Since: 0.1.0.0
slDropPackages :: !(Set PackageName)
Packages present in the parent which should not be included here.
Since: 0.1.0.0
slFlags :: !(Map PackageName (Map FlagName Bool))
Flag values to override from the defaults
Since: 0.1.0.0
slHidden :: !(Map PackageName Bool)
Packages which should be hidden when registering. This will affect, for example, the import parser in the script command. We use a Map instead of just a Set to allow overriding the hidden settings in a parent sl.
Since: 0.1.0.0
slGhcOptions :: !(Map PackageName [Text])
GHC options per package
Since: 0.1.0.0
slPublishTime :: !(Maybe UTCTime)
Publication timestamp for this snapshot. This field is optional, and is for informational purposes only.
Since: 0.1.0.0

Instances

Instances details

ToJSON SnapshotLayer Source #
Instance details Defined in Pantry.Types Methods toJSON :: SnapshotLayer -> Value # toEncoding :: SnapshotLayer -> Encoding # toJSONList :: [SnapshotLayer] -> Value # toEncodingList :: [SnapshotLayer] -> Encoding #
Generic SnapshotLayer Source #
Instance details Defined in Pantry.Types Associated Types type Rep SnapshotLayer :: Type -> Type # Methods from :: SnapshotLayer -> Rep SnapshotLayer x # to :: Rep SnapshotLayer x -> SnapshotLayer #
Show SnapshotLayer Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> SnapshotLayer -> ShowS # show :: SnapshotLayer -> String # showList :: [SnapshotLayer] -> ShowS #
Eq SnapshotLayer Source #
Instance details Defined in Pantry.Types Methods (==) :: SnapshotLayer -> SnapshotLayer -> Bool # (/=) :: SnapshotLayer -> SnapshotLayer -> Bool #
type Rep SnapshotLayer Source #
Instance details Defined in Pantry.Types type Rep SnapshotLayer = D1 ('MetaData "SnapshotLayer" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "SnapshotLayer" 'PrefixI 'True) (((S1 ('MetaSel ('Just "slParent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SnapshotLocation) :: S1 ('MetaSel ('Just "slCompiler") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe WantedCompiler))) :: (S1 ('MetaSel ('Just "slLocations") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [PackageLocationImmutable]) :: S1 ('MetaSel ('Just "slDropPackages") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set PackageName)))) :: ((S1 ('MetaSel ('Just "slFlags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName (Map FlagName Bool))) :: S1 ('MetaSel ('Just "slHidden") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName Bool))) :: (S1 ('MetaSel ('Just "slGhcOptions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName [Text])) :*: S1 ('MetaSel ('Just "slPublishTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UTCTime))))))

toRawSnapshotLayer :: SnapshotLayer -> RawSnapshotLayer Source #

Convert snapshot layer into its "raw" equivalent.

Since: 0.1.0.0

data RawSnapshot Source #

A flattened representation of all the layers in a snapshot.

Since: 0.1.0.0

Constructors

RawSnapshot
Fields rsCompiler :: !WantedCompiler The compiler wanted for this snapshot. rsPackages :: !(Map PackageName RawSnapshotPackage) Packages available in this snapshot for installation. This will be applied on top of any globally available packages. rsDrop :: !(Set PackageName) Global packages that should be dropped/ignored.

data Snapshot Source #

A flattened representation of all the layers in a snapshot.

Since: 0.1.0.0

Constructors

Snapshot
Fields snapshotCompiler :: !WantedCompiler The compiler wanted for this snapshot. snapshotPackages :: !(Map PackageName SnapshotPackage) Packages available in this snapshot for installation. This will be applied on top of any globally available packages. snapshotDrop :: !(Set PackageName) Global packages that should be dropped/ignored.

data RawSnapshotPackage Source #

Settings for a package found in a snapshot.

Since: 0.1.0.0

Constructors

RawSnapshotPackage
Fields rspLocation :: !RawPackageLocationImmutable Where to get the package from rspFlags :: !(Map FlagName Bool) Same as `slFlags` rspHidden :: !Bool Same as `slHidden` rspGhcOptions :: ![Text] Same as `slGhcOptions`

data SnapshotPackage Source #

Settings for a package found in a snapshot.

Since: 0.1.0.0

Constructors

SnapshotPackage
Fields spLocation :: !PackageLocationImmutable Where to get the package from spFlags :: !(Map FlagName Bool) Same as `slFlags` spHidden :: !Bool Same as `slHidden` spGhcOptions :: ![Text] Same as `slGhcOptions`

Instances

Instances details

Show SnapshotPackage Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> SnapshotPackage -> ShowS # show :: SnapshotPackage -> String # showList :: [SnapshotPackage] -> ShowS #

parseWantedCompiler :: Text -> Either PantryException WantedCompiler Source #

Parse a Text into a WantedCompiler value.

Since: 0.1.0.0

data RawPackageMetadata Source #

Metadata provided by a config file for archives and repos. This information can be used for optimized lookups of information like package identifiers, or for validating that the user configuration has the expected information.

Since: 0.1.0.0

Constructors

RawPackageMetadata
Fields rpmName :: !(Maybe PackageName) Package name in the cabal file Since: 0.1.0.0 rpmVersion :: !(Maybe Version) Package version in the cabal file Since: 0.1.0.0 rpmTreeKey :: !(Maybe TreeKey) Tree key of the loaded up package Since: 0.1.0.0

Instances

Instances details

Generic RawPackageMetadata Source #
Instance details Defined in Pantry.Types Associated Types type Rep RawPackageMetadata :: Type -> Type # Methods from :: RawPackageMetadata -> Rep RawPackageMetadata x # to :: Rep RawPackageMetadata x -> RawPackageMetadata #
Show RawPackageMetadata Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> RawPackageMetadata -> ShowS # show :: RawPackageMetadata -> String # showList :: [RawPackageMetadata] -> ShowS #
NFData RawPackageMetadata Source #
Instance details Defined in Pantry.Types Methods rnf :: RawPackageMetadata -> () #
Eq RawPackageMetadata Source #
Instance details Defined in Pantry.Types Methods (==) :: RawPackageMetadata -> RawPackageMetadata -> Bool # (/=) :: RawPackageMetadata -> RawPackageMetadata -> Bool #
Ord RawPackageMetadata Source #
Instance details Defined in Pantry.Types Methods compare :: RawPackageMetadata -> RawPackageMetadata -> Ordering # (<) :: RawPackageMetadata -> RawPackageMetadata -> Bool # (<=) :: RawPackageMetadata -> RawPackageMetadata -> Bool # (>) :: RawPackageMetadata -> RawPackageMetadata -> Bool # (>=) :: RawPackageMetadata -> RawPackageMetadata -> Bool # max :: RawPackageMetadata -> RawPackageMetadata -> RawPackageMetadata # min :: RawPackageMetadata -> RawPackageMetadata -> RawPackageMetadata #
Display RawPackageMetadata Source #
Instance details Defined in Pantry.Types Methods display :: RawPackageMetadata -> Utf8Builder # textDisplay :: RawPackageMetadata -> Text #
type Rep RawPackageMetadata Source #
Instance details Defined in Pantry.Types type Rep RawPackageMetadata = D1 ('MetaData "RawPackageMetadata" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "RawPackageMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "rpmName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe PackageName)) :: (S1 ('MetaSel ('Just "rpmVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Version)) :: S1 ('MetaSel ('Just "rpmTreeKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe TreeKey)))))

data PackageMetadata Source #

Exact metadata specifying concrete package

Since: 0.1.0.0

Constructors

PackageMetadata
Fields pmIdent :: !PackageIdentifier Package identifier in the cabal file Since: 0.1.0.0 pmTreeKey :: !TreeKey Tree key of the loaded up package Since: 0.1.0.0

Instances

Instances details

Generic PackageMetadata Source #
Instance details Defined in Pantry.Types Associated Types type Rep PackageMetadata :: Type -> Type # Methods from :: PackageMetadata -> Rep PackageMetadata x # to :: Rep PackageMetadata x -> PackageMetadata #
Show PackageMetadata Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> PackageMetadata -> ShowS # show :: PackageMetadata -> String # showList :: [PackageMetadata] -> ShowS #
NFData PackageMetadata Source #
Instance details Defined in Pantry.Types Methods rnf :: PackageMetadata -> () #
Eq PackageMetadata Source #
Instance details Defined in Pantry.Types Methods (==) :: PackageMetadata -> PackageMetadata -> Bool # (/=) :: PackageMetadata -> PackageMetadata -> Bool #
Ord PackageMetadata Source #
Instance details Defined in Pantry.Types Methods compare :: PackageMetadata -> PackageMetadata -> Ordering # (<) :: PackageMetadata -> PackageMetadata -> Bool # (<=) :: PackageMetadata -> PackageMetadata -> Bool # (>) :: PackageMetadata -> PackageMetadata -> Bool # (>=) :: PackageMetadata -> PackageMetadata -> Bool # max :: PackageMetadata -> PackageMetadata -> PackageMetadata # min :: PackageMetadata -> PackageMetadata -> PackageMetadata #
Display PackageMetadata Source #
Instance details Defined in Pantry.Types Methods display :: PackageMetadata -> Utf8Builder # textDisplay :: PackageMetadata -> Text #
type Rep PackageMetadata Source #
Instance details Defined in Pantry.Types type Rep PackageMetadata = D1 ('MetaData "PackageMetadata" "Pantry.Types" "pantry-0.9.2-BO58ByD0Ow6LRhpEn4nfNM-internal" 'False) (C1 ('MetaCons "PackageMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "pmIdent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PackageIdentifier) :*: S1 ('MetaSel ('Just "pmTreeKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TreeKey)))

toRawPM :: PackageMetadata -> RawPackageMetadata Source #

Convert package metadata to its "raw" equivalent.

Since: 0.1.0.0

cabalFileName :: PackageName -> SafeFilePath Source #

newtype SnapshotCacheHash Source #

An arbitrary hash for a snapshot, used for finding module names in a snapshot. Mostly intended for Stack's usage.

Since: 0.1.0.0

Constructors

SnapshotCacheHash
Fields unSnapshotCacheHash :: SHA256

Instances

Instances details

Show SnapshotCacheHash Source #
Instance details Defined in Pantry.Types Methods showsPrec :: Int -> SnapshotCacheHash -> ShowS # show :: SnapshotCacheHash -> String # showList :: [SnapshotCacheHash] -> ShowS #

getGlobalHintsFile :: HasPantryConfig env => RIO env (Path Abs File) Source #

Get the path to the global hints cache file

bsToBlobKey :: ByteString -> BlobKey Source #

Creates BlobKey for an input ByteString

Since: 0.1.0.0

warnMissingCabalFile :: HasLogFunc env => RawPackageLocationImmutable -> RIO env () Source #

Warn if the package uses PCHpack.

Since: 0.4.0.0

connRDBMS :: SqlBackend -> Text #

A tag displaying what database the SqlBackend is for. Can be used to differentiate features in downstream libraries for different database backends.