hoogle-5.0.13: Haskell API Search

Safe HaskellNone
LanguageHaskell2010

Hoogle

Description

High level Hoogle API

Synopsis

Documentation

data Database Source #

Database containing Hoogle search data.

withDatabase :: NFData a => FilePath -> (Database -> IO a) -> IO a Source #

Load a database from a file.

searchDatabase :: Database -> String -> [Target] Source #

Search a database, given a query string, produces a list of results.

defaultDatabaseLocation :: IO FilePath Source #

The default location of a database

data Target Source #

A location of documentation.

Constructors

Target 

Fields

Instances

Eq Target Source # 

Methods

(==) :: Target -> Target -> Bool #

(/=) :: Target -> Target -> Bool #

Ord Target Source # 
Show Target Source # 
NFData Target Source # 

Methods

rnf :: Target -> () #

ToJSON Target Source # 

Methods

toJSON :: Target -> Value

toEncoding :: Target -> Encoding

toJSONList :: [Target] -> Value

toEncodingList :: [Target] -> Encoding

type URL = String Source #

A URL, complete with a https: prefix.

hoogle :: [String] -> IO () Source #

Run a command line Hoogle operation.

targetInfo :: Target -> String Source #

Returns the details printed out when hoogle --info is called

targetResultDisplay :: Bool -> Target -> String Source #

Returns the Target formatted as an item to display in the results | Bool argument decides whether links are shown