hoogle-5.0.18.4: Haskell API Search
Safe HaskellNone
LanguageHaskell2010

Hoogle

Description

High level Hoogle API

Synopsis

Documentation

data Database #

Database containing Hoogle search data.

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

Load a database from a file.

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

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

defaultDatabaseLocation :: IO FilePath #

The default location of a database

data Target #

A location of documentation.

Constructors

Target 

Fields

Instances

Instances details
Arbitrary Target # 
Instance details

Defined in Input.Item

FromJSON Target # 
Instance details

Defined in Input.Item

ToJSON Target # 
Instance details

Defined in Input.Item

NFData Target # 
Instance details

Defined in Input.Item

Methods

rnf :: Target -> () #

Show Target # 
Instance details

Defined in Input.Item

Eq Target # 
Instance details

Defined in Input.Item

Methods

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

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

Ord Target # 
Instance details

Defined in Input.Item

type URL = String #

A URL, complete with a https: prefix.

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

Run a command line Hoogle operation.

targetInfo :: Target -> String #

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

targetResultDisplay :: Bool -> Target -> String #

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