Hunt.Common.DocDesc

Documentation

newtype DocDesc

Constructors

DocDesc

Fields

unDesc :: Object

Instances

Eq DocDesc

Show DocDesc

ToJSON DocDesc

FromJSON DocDesc

Binary DocDesc

NFData DocDesc

Typeable * DocDesc

mkDocDesc :: Object -> DocDesc

Smart constructor for document descriptions.

empty :: DocDesc

The empty description.

null :: DocDesc -> Bool

Check if document description is empty.

insert :: ToJSON v => Text -> v -> DocDesc -> DocDesc

Insert key value pair into description.

delete :: Text -> DocDesc -> DocDesc

Remove a key value pair

union :: DocDesc -> DocDesc -> DocDesc

Union of two descriptions.

restrict :: [Text] -> DocDesc -> DocDesc

restrict a DocDesc map to a set of fields

deleteNull :: DocDesc -> DocDesc

lookupValue :: Text -> DocDesc -> Value

lookup :: FromJSON v => Text -> DocDesc -> Maybe v

lookupText :: Text -> DocDesc -> Text

fromList :: ToJSON v => [(Text, v)] -> DocDesc

Create a document description from as list

toList :: DocDesc -> [(Text, Value)]

Create a list from a document description.