Hunt.Common.Document

The document representation.

This includes the

• URI for identification,
• the description for the data itself
• the weight used in ranking and
• optionally a score

Documentation

data Document

The document representation.

Constructors

Document

Fields

uri :: !URI

Unique identifier of the document.

desc :: !Description

Description of the document (simple key-value store).

wght :: !Score

Weight used in ranking (default 1.0).

Instances

Eq Document

Show Document

ToJSON Document

FromJSON Document

Binary Document

NFData Document

LogShow Document

DocumentWrapper Document

emptyDocument :: Document

toApiDocument :: Document -> ApiDocument

fromApiDocument :: ApiDocument -> Document

class NFData e => DocumentWrapper e where

Simple bijection between e and Document for compression.

Minimal complete definition

unwrap, wrap

Methods

unwrap :: e -> Document

Get the document.

wrap :: Document -> e

Create e from document.

update :: (Document -> Document) -> e -> e

Update the wrapped document. update f = wrap . f . unwrap.

Instances

DocumentWrapper Document