-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | provide access to the Hackage database via Data.Map
--   
@package hackage-db
@version 1.9.1


-- | Find the location of the local Hackage database that is maintained by
--   running <tt>cabal update</tt>.
module Distribution.Hackage.DB.Path

-- | Determine the default path of the Hackage database, which typically
--   resides at
--   <tt>"$HOME/.cabal/packages/hackage.haskell.org/00-index.tar"</tt>.
--   Running the command <tt>"cabal update"</tt> will keep that file
--   up-to-date.
hackagePath :: IO FilePath


-- | This module provides simple access to the Hackage database by means of
--   <a>Map</a>.
module Distribution.Hackage.DB.Unparsed

-- | A <a>Map</a> representation of the Hackage database. Every package
--   name maps to a non-empty set of version, and for every version there
--   is a Cabal file stored as a (lazy) <a>ByteString</a>.
type Hackage = Map String (Map Version ByteString)

-- | Read the Hackage database from the location determined by
--   <a>hackagePath</a> and return a <a>Map</a> that provides fast access
--   to its contents.
readHackage :: IO Hackage

-- | Read the Hackage database from the given <a>FilePath</a> and return a
--   <a>Hackage</a> map that provides fast access to its contents.
readHackage' :: FilePath -> IO Hackage

-- | Parse the contents of Hackage's <tt>00-index.tar</tt> into a
--   <a>Hackage</a> map.
parseHackage :: ByteString -> Hackage

-- | Determine the default path of the Hackage database, which typically
--   resides at
--   <tt>"$HOME/.cabal/packages/hackage.haskell.org/00-index.tar"</tt>.
--   Running the command <tt>"cabal update"</tt> will keep that file
--   up-to-date.
hackagePath :: IO FilePath


-- | This module provides simple access to the Hackage database by means of
--   <a>Map</a>.
module Distribution.Hackage.DB.Parsed

-- | A <a>Map</a> representation of the Hackage database. For sake of
--   simplicity, we use <a>String</a> rather than <tt>PackageName</tt> to
--   represent the name of a package.
type Hackage = Map String (Map Version GenericPackageDescription)

-- | Read the Hackage database from the location determined by
--   <tt>hackagePath</tt> and return a <a>Map</a> that provides fast access
--   to its contents.
readHackage :: IO Hackage

-- | Read the Hackage database from the given <a>FilePath</a> and return a
--   <a>Hackage</a> map that provides fast access to its contents.
readHackage' :: FilePath -> IO Hackage

-- | Parse the contents of Hackage's <tt>00-index.tar</tt> into a
--   <a>Hackage</a> map.
parseHackage :: ByteString -> Hackage

-- | Convert an <a>Hackage</a> map into a parsed <a>Hackage</a> map.
parseUnparsedHackage :: Hackage -> Hackage


-- | This module provides simple access to the Hackage database by means of
--   <a>Map</a>.
module Distribution.Hackage.DB

-- | A <a>Map</a> representation of the Hackage database. For sake of
--   simplicity, we use <a>String</a> rather than <tt>PackageName</tt> to
--   represent the name of a package.
type Hackage = Map String (Map Version GenericPackageDescription)

-- | Read the Hackage database from the location determined by
--   <tt>hackagePath</tt> and return a <a>Map</a> that provides fast access
--   to its contents.
readHackage :: IO Hackage

-- | Read the Hackage database from the given <a>FilePath</a> and return a
--   <a>Hackage</a> map that provides fast access to its contents.
readHackage' :: FilePath -> IO Hackage

-- | Parse the contents of Hackage's <tt>00-index.tar</tt> into a
--   <a>Hackage</a> map.
parseHackage :: ByteString -> Hackage

-- | Determine the default path of the Hackage database, which typically
--   resides at
--   <tt>"$HOME/.cabal/packages/hackage.haskell.org/00-index.tar"</tt>.
--   Running the command <tt>"cabal update"</tt> will keep that file
--   up-to-date.
hackagePath :: IO FilePath