Modulecabal-install-solver-3.12.1.0Haskell2010

Distribution.Solver.Types.PackageIndex

An index of packages.

2 types
17 values

Packagecabal-install-solver-3.12.1.0
Exports19
LanguageHaskell2010
LicenceBSD-3-Clause
SourcePackageIndex.hs

Package index data type

1 declaration

newtypenewtype PackageIndex pkg

The collection of information about packages from one or more PackageDBs.

It can be searched efficiently by package name and version.

Instances9Functor, Eq, Read, Show, Generic, Semigroup, …

Functor PackageIndexDefined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
Eq pkg => Eq (PackageIndex pkg)Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
Read pkg => Read (PackageIndex pkg)Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
Show pkg => Show (PackageIndex pkg)Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
Generic (PackageIndex pkg)Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
Package pkg => Semigroup (PackageIndex pkg)Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
Package pkg => Monoid (PackageIndex pkg)Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
Binary pkg => Binary (PackageIndex pkg)Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex
type Rep (PackageIndex pkg) = D1 ('MetaData "PackageIndex" "Distribution.Solver.Types.PackageIndex" "cabal-install-solver-3.12.1.0-582X8xReBAn365xYF5myIO" 'True) (C1 ('MetaCons "PackageIndex" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map PackageName [pkg]))))Defined in cabal-install-solver-3.12.1.0 · Distribution.Solver.Types.PackageIndex

Creating an index

1 declaration

valuefromList :: Package pkg => [pkg] -> PackageIndex pkg

Build an index out of a bunch of packages.

If there are duplicates, later ones mask earlier ones.

Updates

6 declarations

valuemerge

:: Package pkg
=> PackageIndex pkg
-> PackageIndex pkg
-> PackageIndex pkg

Merge two indexes.

Packages from the second mask packages of the same exact name (case-sensitively) from the first.

valueoverride

:: Package pkg
=> PackageIndex pkg
-> PackageIndex pkg
-> PackageIndex pkg

Override-merge of two indexes.

Packages from the second mask packages of the same exact name (case-sensitively) from the first.

valueinsert :: Package pkg => pkg -> PackageIndex pkg -> PackageIndex pkg

Inserts a single package into the index.

This is equivalent to (but slightly quicker than) using mappend or merge with a singleton index.

valuedeletePackageName

:: Package pkg
=> PackageName
-> PackageIndex pkg
-> PackageIndex pkg

Removes all packages with this (case-sensitive) name from the index.

valuedeletePackageId

:: Package pkg
=> PackageIdentifier
-> PackageIndex pkg
-> PackageIndex pkg

Removes a single package from the index.

valuedeleteDependency

:: Package pkg
=> PackageName
-> VersionRange
-> PackageIndex pkg
-> PackageIndex pkg

Removes all packages satisfying this dependency from the index.

Queries

0 declarations

Precise lookups

valueelemByPackageId

:: Package pkg
=> PackageIndex pkg
-> PackageIdentifier
-> Bool

valueelemByPackageName :: Package pkg => PackageIndex pkg -> PackageName -> Bool

valuelookupPackageName :: Package pkg => PackageIndex pkg -> PackageName -> [pkg]

Does a case-sensitive search by package name.

valuelookupPackageId

:: Package pkg
=> PackageIndex pkg
-> PackageIdentifier
-> Maybe pkg

Does a lookup by package id (name & version).

Since multiple package DBs mask each other case-sensitively by package name, then we get back at most one package.

valuelookupDependency

:: Package pkg
=> PackageIndex pkg
-> PackageName
-> VersionRange
-> [pkg]

Does a case-sensitive search by package name and a range of versions.

We get back any number of versions of the specified package name, all satisfying the version range constraint.

Case-insensitive searches

valuesearchByName :: PackageIndex pkg -> String -> [(PackageName, [pkg])]

Does a case-insensitive search by package name.

If there is only one package that compares case-insensitively to this name then the search is unambiguous and we get back all versions of that package. If several match case-insensitively but one matches exactly then it is also unambiguous.

If however several match case-insensitively and none match exactly then we have an ambiguous result, and we get back all the versions of all the packages. The list of ambiguous results is split by exact package name. So it is a non-empty list of non-empty lists.

datadata SearchResult a

Constructors

None
Unambiguous a
Ambiguous [a]

valuesearchByNameSubstring

:: PackageIndex pkg
-> String
-> [(PackageName, [pkg])]

Does a case-insensitive substring search by package name.

That is, all packages that contain the given string in their name.

valuesearchWithPredicate

:: PackageIndex pkg
-> String -> Bool
-> [(PackageName, [pkg])]

Bulk queries

valueallPackages :: PackageIndex pkg -> [pkg]

Get all the packages from the index.

valueallPackagesByName :: PackageIndex pkg -> [[pkg]]

Get all the packages from the index.

They are grouped by package name, case-sensitively.