Hackage.Index

Documentation

getCabal :: PackageIdentifier -> IO ByteString

Get the contents of the .cabal file for package version

getCabals :: PackageIdentifier -> PackageIdentifier -> IO (ByteString, ByteString)

Get two .cabal files at once!

withCabalFile :: PackageIdentifier -> (FilePath -> IO a) -> IO a

Pass a temporary copy of .cabal file to some action

listPackages :: IO [String]

List all packages in the index (unsorted for performance)

packageVersions :: PackageName -> IO [Version]

Get all versions of a package in the index

latestVersion :: PackageName -> IO (Maybe Version)

Get the latest version of package from the index

Note: does not take preferred-versions into account

preferredVersions :: PackageName -> IO (Maybe ByteString)

Get the preferred-versions metadata for package

getTimestamp :: PackageIdentifier -> IO (Maybe UTCTime)

Get the index timestamp for (the latest revision of) pkgid

indexFiles :: IO [String]

List all files in the Hackage index (.cabal files, metadata .json files, preferred-versions files)

getPackageDescription :: PackageIdentifier -> IO (Maybe PackageDescription)

Get and try to parse the PackageDescription of a package version

getPackageDescription' :: PackageIdentifier -> IO PackageDescription

Get and parse PackageDescription of package version

Raises an error on failure.

packageIdOrLatest :: PackageIdentifier -> IO PackageIdentifier

Convert a PackageID if unversioned to latest package version

getFileInfo :: PackageIdentifier -> IO FileInfo

Get FileInfo metadata for package version source

Re-exports from hackage-security

data FileInfo

File information

This intentionally does not have an Eq instance; see knownFileInfoEqual and verifyFileInfo instead.

NOTE: Throughout we compute file information always over the raw bytes. For example, when timestamp.json lists the hash of snapshot.json, this hash is computed over the actual snapshot.json file (as opposed to the canonical form of the embedded JSON). This brings it in line with the hash computed over target files, where that is the only choice available.

Constructors

FileInfo

Fields

• fileInfoLength :: FileLength
• fileInfoHashes :: Map HashFn Hash

Instances

Show FileInfo

Defined in Hackage.Security.TUF.FileInfo

Methods

showsPrec :: Int -> FileInfo -> ShowS

show :: FileInfo -> String

showList :: [FileInfo] -> ShowS

Monad m => ToJSON m FileInfo

Defined in Hackage.Security.TUF.FileInfo

Methods

toJSON :: FileInfo -> m JSValue

ReportSchemaErrors m => FromJSON m FileInfo

Defined in Hackage.Security.TUF.FileInfo

Methods

fromJSON :: JSValue -> m FileInfo

newtype FileLength

File length

Having verified file length information means we can protect against endless data attacks and similar.

Constructors

FileLength

Fields

• fileLength :: Int54

Instances

Eq FileLength

Defined in Hackage.Security.TUF.Common

Methods

(==) :: FileLength -> FileLength -> Bool

(/=) :: FileLength -> FileLength -> Bool

Ord FileLength

Defined in Hackage.Security.TUF.Common

Methods

compare :: FileLength -> FileLength -> Ordering

(<) :: FileLength -> FileLength -> Bool

(<=) :: FileLength -> FileLength -> Bool

(>) :: FileLength -> FileLength -> Bool

(>=) :: FileLength -> FileLength -> Bool

max :: FileLength -> FileLength -> FileLength

min :: FileLength -> FileLength -> FileLength

Show FileLength

Defined in Hackage.Security.TUF.Common

Methods

showsPrec :: Int -> FileLength -> ShowS

show :: FileLength -> String

showList :: [FileLength] -> ShowS

Monad m => ToJSON m FileLength

Defined in Hackage.Security.TUF.Common

Methods

toJSON :: FileLength -> m JSValue

ReportSchemaErrors m => FromJSON m FileLength

Defined in Hackage.Security.TUF.Common

Methods

fromJSON :: JSValue -> m FileLength

fileInfoSHA256 :: FileInfo -> Maybe Hash

Extract SHA256 hash from FileInfo (if present)