scion-browser-0.1.3.2: Command-line interface for browsing and searching packages documentation

Scion.Browser.Query

Synopsis

Documentation

allPackageIds :: Database -> [PackageIdentifier]Source

Get the identifiers of all packages in the database.

allPackages :: Database -> [Documented Package]Source

Get information of all packages in the database.

packagesByName :: String -> Database -> [Documented Package]Source

Get information of all versions of the package with that name.

getPackage :: PackageIdentifier -> Database -> Maybe (Documented Package)Source

Get information about a package in the database.

getSingletonDatabase :: PackageIdentifier -> Database -> Maybe DatabaseSource

Builds a database with only the specified package.

getModules :: String -> Database -> [(String, [ModuleWithPackage])]Source

getSubmodules :: String -> Database -> [(String, [ModuleWithPackage])]Source

getDeclsInModule :: String -> Database -> [(PackageIdentifier, [Documented Decl])]Source

Gets the declarations inside some module, along with information about which package it lives.

getModulesWhereDeclarationIs :: String -> Database -> [Documented Module]Source

Gets a list of modules where a declaration may live