Show MetadataParseError Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> MetadataParseError -> ShowS # show :: MetadataParseError -> String # showList :: [MetadataParseError] -> ShowS #
Exception MetadataParseError Source #
Instance details Defined in Cabal.Index Methods toException :: MetadataParseError -> SomeException # fromException :: SomeException -> Maybe MetadataParseError # displayException :: MetadataParseError -> String #

data InvalidHash Source #

Thrown if we fail consistency check, we don't know a hash for some file.

Constructors

InvalidHash PackageName Version String

Instances

Show InvalidHash Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> InvalidHash -> ShowS # show :: InvalidHash -> String # showList :: [InvalidHash] -> ShowS #
Exception InvalidHash Source #
Instance details Defined in Cabal.Index Methods toException :: InvalidHash -> SomeException # fromException :: SomeException -> Maybe InvalidHash # displayException :: InvalidHash -> String #

newtype InvalidIndexFile Source #

Thrown when when not a .cabal, package.json or preferred-versions file is encountered.

Constructors

InvalidIndexFile String

Instances

Show InvalidIndexFile Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> InvalidIndexFile -> ShowS # show :: InvalidIndexFile -> String # showList :: [InvalidIndexFile] -> ShowS #
Exception InvalidIndexFile Source #
Instance details Defined in Cabal.Index Methods toException :: InvalidIndexFile -> SomeException # fromException :: SomeException -> Maybe InvalidIndexFile # displayException :: InvalidIndexFile -> String #

data NoHackageRepository Source #

Constructors

NoHackageRepository

Instances

Show NoHackageRepository Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> NoHackageRepository -> ShowS # show :: NoHackageRepository -> String # showList :: [NoHackageRepository] -> ShowS #
Exception NoHackageRepository Source #
Instance details Defined in Cabal.Index Methods toException :: NoHackageRepository -> SomeException # fromException :: SomeException -> Maybe NoHackageRepository # displayException :: NoHackageRepository -> String #

Metadata types

data PackageInfo Source #

Package information.

Constructors

PackageInfo
Fields piVersions :: Map Version ReleaseInfo individual package releases piPreferred :: VersionRange preferred versions range

Instances

Eq PackageInfo Source #
Instance details Defined in Cabal.Index Methods (==) :: PackageInfo -> PackageInfo -> Bool # (/=) :: PackageInfo -> PackageInfo -> Bool #
Show PackageInfo Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> PackageInfo -> ShowS # show :: PackageInfo -> String # showList :: [PackageInfo] -> ShowS #
Generic PackageInfo Source #
Instance details Defined in Cabal.Index Associated Types type Rep PackageInfo :: Type -> Type # Methods from :: PackageInfo -> Rep PackageInfo x # to :: Rep PackageInfo x -> PackageInfo #
Binary PackageInfo Source #
Instance details Defined in Cabal.Index Methods put :: PackageInfo -> Put # get :: Get PackageInfo # putList :: [PackageInfo] -> Put #
type Rep PackageInfo Source #
Instance details Defined in Cabal.Index type Rep PackageInfo = D1 (MetaData "PackageInfo" "Cabal.Index" "cabal-install-parsers-0.3-5B8sGi9yrty8vUwhtChFwT" False) (C1 (MetaCons "PackageInfo" PrefixI True) (S1 (MetaSel (Just "piVersions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Version ReleaseInfo)) :*: S1 (MetaSel (Just "piPreferred") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VersionRange)))

piPreferredVersions :: PackageInfo -> Map Version ReleaseInfo Source #

Like piVersions, but return only piPreferred versions.

data ReleaseInfo Source #

Package's release information.

Constructors

ReleaseInfo
Fields riRevision :: Word revision number riCabal :: SHA256 hash of the last revision of `.cabal` file riTarball :: SHA256 hash of the `.tar.gz` file.

Instances

Eq ReleaseInfo Source #
Instance details Defined in Cabal.Index Methods (==) :: ReleaseInfo -> ReleaseInfo -> Bool # (/=) :: ReleaseInfo -> ReleaseInfo -> Bool #
Show ReleaseInfo Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> ReleaseInfo -> ShowS # show :: ReleaseInfo -> String # showList :: [ReleaseInfo] -> ShowS #
Generic ReleaseInfo Source #
Instance details Defined in Cabal.Index Associated Types type Rep ReleaseInfo :: Type -> Type # Methods from :: ReleaseInfo -> Rep ReleaseInfo x # to :: Rep ReleaseInfo x -> ReleaseInfo #
Binary ReleaseInfo Source #
Instance details Defined in Cabal.Index Methods put :: ReleaseInfo -> Put # get :: Get ReleaseInfo # putList :: [ReleaseInfo] -> Put #
type Rep ReleaseInfo Source #
Instance details Defined in Cabal.Index type Rep ReleaseInfo = D1 (MetaData "ReleaseInfo" "Cabal.Index" "cabal-install-parsers-0.3-5B8sGi9yrty8vUwhtChFwT" False) (C1 (MetaCons "ReleaseInfo" PrefixI True) (S1 (MetaSel (Just "riRevision") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word) :: (S1 (MetaSel (Just "riCabal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SHA256) :: S1 (MetaSel (Just "riTarball") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SHA256))))

Hashes

data SHA256 Source #

SHA256 result.

Instances

Eq SHA256 Source #
Instance details Defined in Cabal.Index Methods (==) :: SHA256 -> SHA256 -> Bool # (/=) :: SHA256 -> SHA256 -> Bool #
Ord SHA256 Source #
Instance details Defined in Cabal.Index 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 #
Show SHA256 Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> SHA256 -> ShowS # show :: SHA256 -> String # showList :: [SHA256] -> ShowS #
Pretty SHA256 Source #
Instance details Defined in Cabal.Index Methods pretty :: SHA256 -> Doc # prettyVersioned :: CabalSpecVersion -> SHA256 -> Doc #
Binary SHA256 Source #
Instance details Defined in Cabal.Index Methods put :: SHA256 -> Put # get :: Get SHA256 # putList :: [SHA256] -> Put #

sha256 :: ByteString -> SHA256 Source #

Hash strict ByteString.

validSHA256 :: SHA256 -> Bool Source #

Check invariants of SHA256

mkSHA256 :: Text -> Either String SHA256 Source #

Make SHA256 from base16-encoded string.

unsafeMkSHA256 :: Text -> SHA256 Source #

Unsafe variant of mkSHA256.

getSHA256 :: SHA256 -> ByteString Source #

Get underlying ByteString of SHA256.

Generic folding

foldIndex Source #

Arguments

:: FilePath	path to the `01-index.tar` file
-> a	initial value
-> (IndexEntry -> ByteString -> a -> IO a)
-> IO a

Fold over Hackage 01-index.tar file.

May throw FormatError or InvalidIndexFile.

data IndexEntry Source #

Constructors

IndexEntry
Fields entryPath :: FilePath entryType :: IndexFileType entryPermissions :: Permissions entryOwnership :: Ownership entryTime :: EpochTime

Instances

Show IndexEntry Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> IndexEntry -> ShowS # show :: IndexEntry -> String # showList :: [IndexEntry] -> ShowS #

data IndexFileType Source #

Varions files in 01-index.tar.

Constructors

CabalFile PackageName Version
PackageJson PackageName Version
PreferredVersions PackageName

Instances

Show IndexFileType Source #
Instance details Defined in Cabal.Index Methods showsPrec :: Int -> IndexFileType -> ShowS # show :: IndexFileType -> String # showList :: [IndexFileType] -> ShowS #