Cabal.Index

Metadata construction

indexMetadata

Arguments

:: FilePath

location

-> Maybe EpochTime

index state to stop

-> IO (Map PackageName PackageInfo)

Read index file and return the metadata about packages.

It takes about 6 seconds on my machine. Consider using cachedHackageMetadata.

cachedHackageMetadata :: IO (FilePath, Map PackageName PackageInfo)

Read the config and then Hackage index metadata.

This method caches the result in XDG_CACHE/cabal-parsers directory.

Returns the location of index tarball and its contents.

Exceptions thrown

data MetadataParseError

Thrown when we cannot parse package.json or preferred-versions files.

Constructors

MetadataParseError FilePath String

Instances

Show MetadataParseError

Defined in Cabal.Index

Methods

showsPrec :: Int -> MetadataParseError -> ShowS

show :: MetadataParseError -> String

showList :: [MetadataParseError] -> ShowS

Exception MetadataParseError

Defined in Cabal.Index

Methods

toException :: MetadataParseError -> SomeException

fromException :: SomeException -> Maybe MetadataParseError

displayException :: MetadataParseError -> String

data InvalidHash

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

Constructors

InvalidHash PackageName Version String

Instances

Show InvalidHash

Defined in Cabal.Index

Methods

showsPrec :: Int -> InvalidHash -> ShowS

show :: InvalidHash -> String

showList :: [InvalidHash] -> ShowS

Exception InvalidHash

Defined in Cabal.Index

Methods

toException :: InvalidHash -> SomeException

fromException :: SomeException -> Maybe InvalidHash

displayException :: InvalidHash -> String

newtype InvalidIndexFile

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

Constructors

InvalidIndexFile String

Instances

Show InvalidIndexFile

Defined in Cabal.Index

Methods

showsPrec :: Int -> InvalidIndexFile -> ShowS

show :: InvalidIndexFile -> String

showList :: [InvalidIndexFile] -> ShowS

Exception InvalidIndexFile

Defined in Cabal.Index

Methods

toException :: InvalidIndexFile -> SomeException

fromException :: SomeException -> Maybe InvalidIndexFile

displayException :: InvalidIndexFile -> String

data NoHackageRepository

Constructors

NoHackageRepository

Instances

Show NoHackageRepository

Defined in Cabal.Index

Methods

showsPrec :: Int -> NoHackageRepository -> ShowS

show :: NoHackageRepository -> String

showList :: [NoHackageRepository] -> ShowS

Exception NoHackageRepository

Defined in Cabal.Index

Methods

toException :: NoHackageRepository -> SomeException

fromException :: SomeException -> Maybe NoHackageRepository

displayException :: NoHackageRepository -> String

Metadata types

data PackageInfo

Package information.

Constructors

PackageInfo

Fields

• piVersions :: Map Version ReleaseInfo

  individual package releases

• piPreferred :: VersionRange

  preferred versions range

Instances

Eq PackageInfo

Defined in Cabal.Index

Methods

(==) :: PackageInfo -> PackageInfo -> Bool

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

Show PackageInfo

Defined in Cabal.Index

Methods

showsPrec :: Int -> PackageInfo -> ShowS

show :: PackageInfo -> String

showList :: [PackageInfo] -> ShowS

Generic PackageInfo

Defined in Cabal.Index

Associated Types

type Rep PackageInfo :: Type -> Type

Methods

from :: PackageInfo -> Rep PackageInfo x

to :: Rep PackageInfo x -> PackageInfo

Binary PackageInfo

Defined in Cabal.Index

Methods

put :: PackageInfo -> Put

get :: Get PackageInfo

putList :: [PackageInfo] -> Put

type Rep PackageInfo

Defined in Cabal.Index

type Rep PackageInfo = D1 (MetaData "PackageInfo" "Cabal.Index" "cabal-install-parsers-0.4-w4mTgtw0tJ6iqwagB75LL" 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

Like piVersions, but return only piPreferred versions.

data ReleaseInfo

Package's release information.

Constructors

ReleaseInfo

Fields

• riRevision :: !Word32

  revision number

• riTarOffset :: !TarEntryOffset

  offset into tar file

• riCabal :: !SHA256

  hash of the last revision of .cabal file

• riTarball :: !SHA256

  hash of the .tar.gz file.

Instances

Eq ReleaseInfo

Defined in Cabal.Index

Methods

(==) :: ReleaseInfo -> ReleaseInfo -> Bool

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

Show ReleaseInfo

Defined in Cabal.Index

Methods

showsPrec :: Int -> ReleaseInfo -> ShowS

show :: ReleaseInfo -> String

showList :: [ReleaseInfo] -> ShowS

Generic ReleaseInfo

Defined in Cabal.Index

Associated Types

type Rep ReleaseInfo :: Type -> Type

Methods

from :: ReleaseInfo -> Rep ReleaseInfo x

to :: Rep ReleaseInfo x -> ReleaseInfo

Binary ReleaseInfo

Defined in Cabal.Index

Methods

put :: ReleaseInfo -> Put

get :: Get ReleaseInfo

putList :: [ReleaseInfo] -> Put

type Rep ReleaseInfo

Defined in Cabal.Index

type Rep ReleaseInfo = D1 (MetaData "ReleaseInfo" "Cabal.Index" "cabal-install-parsers-0.4-w4mTgtw0tJ6iqwagB75LL" False) (C1 (MetaCons "ReleaseInfo" PrefixI True) ((S1 (MetaSel (Just "riRevision") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word32) :*: S1 (MetaSel (Just "riTarOffset") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TarEntryOffset)) :*: (S1 (MetaSel (Just "riCabal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SHA256) :*: S1 (MetaSel (Just "riTarball") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SHA256))))

Hashes

data SHA256

SHA256 digest. 256 bytes.

Constructors

SHA256 !Word64 !Word64 !Word64 !Word64

Instances

Eq SHA256

Defined in Cabal.Index

Methods

(==) :: SHA256 -> SHA256 -> Bool

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

Ord SHA256

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

Defined in Cabal.Index

Methods

showsPrec :: Int -> SHA256 -> ShowS

show :: SHA256 -> String

showList :: [SHA256] -> ShowS

Pretty SHA256

Defined in Cabal.Index

Methods

pretty :: SHA256 -> Doc

prettyVersioned :: CabalSpecVersion -> SHA256 -> Doc

Binary SHA256

Defined in Cabal.Index

Methods

put :: SHA256 -> Put

get :: Get SHA256

putList :: [SHA256] -> Put

sha256 :: ByteString -> SHA256

Hash strict ByteString.

mkSHA256 :: Text -> Either String SHA256

Make SHA256 from base16-encoded string.

unsafeMkSHA256 :: Text -> SHA256

Unsafe variant of mkSHA256.

getSHA256 :: SHA256 -> ByteString

Get ByteString representation of SHA256.

Generic folding

foldIndex

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

Constructors

IndexEntry

Fields

• entryPath :: !FilePath
• entryType :: !IndexFileType
• entryPermissions :: !Permissions
• entryOwnership :: !Ownership
• entryTime :: !EpochTime
• entryTarOffset :: !TarEntryOffset

Instances

Show IndexEntry

Defined in Cabal.Index

Methods

showsPrec :: Int -> IndexEntry -> ShowS

show :: IndexEntry -> String

showList :: [IndexEntry] -> ShowS

data IndexFileType

Varions files in 01-index.tar.

Constructors

CabalFile PackageName Version

PackageJson PackageName Version

PreferredVersions PackageName

Instances

Show IndexFileType

Defined in Cabal.Index

Methods

showsPrec :: Int -> IndexFileType -> ShowS

show :: IndexFileType -> String

showList :: [IndexFileType] -> ShowS