Safe Haskell | None |
---|---|
Language | Haskell98 |
Hunt.Common.ApiDocument
Description
Document format for the interpreter and JSON API. It includes the document description, the index data and additional metadata.
- data ApiDocument = ApiDocument {}
- type IndexMap = Map Context Content
- type ApiDocuments = [ApiDocument]
- type AnalyzerFunction = Text -> [(Position, Text)]
- data AnalyzerType = DefaultAnalyzer
- data LimitedResult x = LimitedResult {}
- mkLimitedResult :: Int -> Int -> [x] -> LimitedResult x
- emptyApiDocIndexMap :: IndexMap
- emptyApiDocDescr :: Description
- emptyApiDoc :: ApiDocument
Documentation
data ApiDocument Source
The document accepted by the interpreter and JSON API.
Constructors
ApiDocument | |
type ApiDocuments = [ApiDocument] Source
Multiple ApiDocument
s.
type AnalyzerFunction = Text -> [(Position, Text)] Source
Text analysis function
data LimitedResult x Source
Paginated result with an offset and chunk size.
Constructors
LimitedResult | |
Instances
Eq x => Eq (LimitedResult x) | |
Show x => Show (LimitedResult x) | |
ToJSON x => ToJSON (LimitedResult x) | |
FromJSON x => FromJSON (LimitedResult x) | |
NFData x => NFData (LimitedResult x) |
mkLimitedResult :: Int -> Int -> [x] -> LimitedResult x Source
Create a paginated result with an offset and a chunk size. The result also includes the size of the complete result.
emptyApiDocIndexMap :: IndexMap Source
Empty index content.
emptyApiDocDescr :: Description Source
Empty Document
description.
emptyApiDoc :: ApiDocument Source
Empty ApiDocument
.