Stack.Types.Installed

This module contains all the types related to the idea of installing a package in the pkg-db or an executable on the file system.

Documentation

data InstallLocation

Type representing user package databases that packages can be installed into.

Constructors

Snap

The write-only package database, formerly known as the snapshot database.

Local

The mutable package database, formerly known as the local database.

Instances

Monoid InstallLocation

Defined in Stack.Types.Installed

Methods

mempty :: InstallLocation

mappend :: InstallLocation -> InstallLocation -> InstallLocation

mconcat :: [InstallLocation] -> InstallLocation

Semigroup InstallLocation

Defined in Stack.Types.Installed

Methods

(<>) :: InstallLocation -> InstallLocation -> InstallLocation

sconcat :: NonEmpty InstallLocation -> InstallLocation

stimes :: Integral b => b -> InstallLocation -> InstallLocation

Show InstallLocation

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> InstallLocation -> ShowS

show :: InstallLocation -> String

showList :: [InstallLocation] -> ShowS

Eq InstallLocation

Defined in Stack.Types.Installed

Methods

(==) :: InstallLocation -> InstallLocation -> Bool

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

data InstalledPackageLocation

Type representing user (non-global) package databases that can provide installed packages.

Constructors

InstalledTo InstallLocation

A package database that a package can be installed into.

ExtraPkgDb

An 'extra' package database, specified by extra-package-dbs.

Instances

Show InstalledPackageLocation

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> InstalledPackageLocation -> ShowS

show :: InstalledPackageLocation -> String

showList :: [InstalledPackageLocation] -> ShowS

Eq InstalledPackageLocation

Defined in Stack.Types.Installed

Methods

(==) :: InstalledPackageLocation -> InstalledPackageLocation -> Bool

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

data PackageDatabase

Type representing package databases that can provide installed packages.

Constructors

GlobalPkgDb

GHC's global package database.

UserPkgDb InstalledPackageLocation (Path Abs Dir)

A user package database.

Instances

Show PackageDatabase

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> PackageDatabase -> ShowS

show :: PackageDatabase -> String

showList :: [PackageDatabase] -> ShowS

Eq PackageDatabase

Defined in Stack.Types.Installed

Methods

(==) :: PackageDatabase -> PackageDatabase -> Bool

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

data PackageDbVariety

Type representing varieties of package databases that can provide installed packages.

Constructors

GlobalDb

GHC's global package database.

ExtraDb

An 'extra' package database, specified by extra-package-dbs.

WriteOnlyDb

The write-only package database, for immutable packages.

MutableDb

The mutable package database.

Instances

Show PackageDbVariety

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> PackageDbVariety -> ShowS

show :: PackageDbVariety -> String

showList :: [PackageDbVariety] -> ShowS

Eq PackageDbVariety

Defined in Stack.Types.Installed

Methods

(==) :: PackageDbVariety -> PackageDbVariety -> Bool

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

type InstallMap = Map PackageName (InstallLocation, Version)

Type synonym representing dictionaries of package names for a project's packages and dependencies, and pairs of their relevant database (write-only or mutable) and package versions.

data Installed

Type representing information about what is installed.

Constructors

Library PackageIdentifier InstalledLibraryInfo

A library, including its installed package id and, optionally, its license.

Executable PackageIdentifier

An executable.

Instances

Show Installed

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> Installed -> ShowS

show :: Installed -> String

showList :: [Installed] -> ShowS

Eq Installed

Defined in Stack.Types.Installed

Methods

(==) :: Installed -> Installed -> Bool

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

type InstalledMap = Map PackageName (InstallLocation, Installed)

Type synonym representing dictionaries of package names, and a pair of in which package database the package is installed (write-only or mutable) and information about what is installed.

data InstalledLibraryInfo

Constructors

InstalledLibraryInfo

Fields

• ghcPkgId :: GhcPkgId
• license :: Maybe (Either License License)
• subLib :: Map StackUnqualCompName GhcPkgId

Instances

Show InstalledLibraryInfo

Defined in Stack.Types.Installed

Methods

showsPrec :: Int -> InstalledLibraryInfo -> ShowS

show :: InstalledLibraryInfo -> String

showList :: [InstalledLibraryInfo] -> ShowS

Eq InstalledLibraryInfo

Defined in Stack.Types.Installed

Methods

(==) :: InstalledLibraryInfo -> InstalledLibraryInfo -> Bool

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

toPackageDbVariety :: PackageDatabase -> PackageDbVariety

A function to yield the variety of package database for a given package database that can provide installed packages.

installedLibraryInfoFromGhcPkgId :: GhcPkgId -> InstalledLibraryInfo

simpleInstalledLib :: PackageIdentifier -> GhcPkgId -> Map StackUnqualCompName GhcPkgId -> Installed

installedToPackageIdOpt :: InstalledLibraryInfo -> [String]

installedPackageIdentifier :: Installed -> PackageIdentifier

installedVersion :: Installed -> Version

Get the installed Version.

foldOnGhcPkgId' :: (Maybe StackUnqualCompName -> GhcPkgId -> resT -> resT) -> Installed -> resT -> resT

A strict fold over the GhcPkgId of the given installed package. This will iterate on both sub and main libraries, if any.