Yesod.Goodies.Search

Documentation

data SearchResult a

A ranked search result

Constructors

SearchResult

Fields

searchRank :: Double

searchResult :: a

class Search a where

Any item can be searched by providing a match function.

Methods

preference :: SearchResult a -> SearchResult a -> Ordering

If two results have the same rank, optionally lend preference to one. The greater value will appear first.

match :: Text -> a -> Maybe (SearchResult a)

Given a search term and some a, provide Just a ranked result or Nothing.

search :: Search a => Text -> [a] -> [SearchResult a]

Excute a search on a list of as and rank the results

search_ :: Search a => Text -> [a] -> [a]

Identical but discards the actual rank values.

weightedSearch :: Search a => (a -> Double) -> Text -> [a] -> [SearchResult a]

Add (or remove) weight from items that have certian properties.

weightedSearch_ :: Search a => (a -> Double) -> Text -> [a] -> [a]

search helpers

class TextSearch a where

Being a member of this class means defining the way to represent your type as pure text so it can be searched by keyword, etc.

Methods

toText :: a -> Text

keywordMatch :: TextSearch a => Text -> a -> Maybe (SearchResult a)

Search term is interpreted as keywords. Results are ranked by the number of words that appear in the source text, a rank of 0 returns Nothing.