Safe Haskell	None
Language	Haskell2010

Imm

Description

Meta-module that reexports many Imm sub-modules.

Synopsis

data LogLevel
- = Debug
- | Info
- | Warning
- | Error
log :: Handle m -> LogLevel -> Doc AnsiStyle -> m ()
getLogLevel :: Handle m -> m LogLevel
setLogLevel :: Handle m -> LogLevel -> m ()
setColorizeLogs :: Handle m -> Bool -> m ()
flushLogs :: Handle m -> m ()
httpGet :: Handle m -> URI -> m LByteString
get :: Monad m => Handle m -> Handle m -> URI -> m LByteString
data FeedURI = FeedURI (URIRef a)
data FeedElement
- = RssElement (RssItem '[ContentModule, DublinCoreModule])
- | AtomElement AtomEntry
data Feed
- = Rss (RssDocument '[ContentModule, DublinCoreModule])
- | Atom AtomFeed
data FeedRef
- = ByUID Int
- | ByURI URI
sameURIType :: URIRef a1 -> URIRef a2 -> Maybe (URIRef a1 :~: URIRef a2)
withFeedURI :: (forall a. URIRef a -> b) -> FeedURI -> b
renderFeed :: Feed -> Text
renderFeedElement :: FeedElement -> Text
parseFeed :: MonadCatch m => Text -> m Feed
parseFeedElement :: MonadCatch m => Text -> m FeedElement
removeElements :: Feed -> Feed
getFeedTitle :: Feed -> Text
getElements :: Feed -> [FeedElement]
getDate :: FeedElement -> Maybe UTCTime
getTitle :: FeedElement -> Text
getContent :: FeedElement -> Text
getLink :: FeedElement -> Maybe FeedURI
getId :: FeedElement -> Text
prettyElement :: FeedElement -> Doc a
parseXml :: Handle m -> URI -> LByteString -> m Feed
data DatabaseException t
- = NotCommitted t
- | NotDeleted t [Key t]
- | NotFound t [Key t]
- | NotInserted t [(Key t, Entry t)]
- | NotPurged t
- | NotUpdated t (Key t)
- | UnableFetchAll t
_describeDatabase :: Handle m t -> m (Doc AnsiStyle)
_fetchList :: Handle m t -> [Key t] -> m (Map (Key t) (Entry t))
_fetchAll :: Handle m t -> m (Map (Key t) (Entry t))
_update :: Handle m t -> Key t -> (Entry t -> Entry t) -> m ()
_insertList :: Handle m t -> [(Key t, Entry t)] -> m ()
_deleteList :: Handle m t -> [Key t] -> m ()
_purge :: Handle m t -> m ()
_commit :: Handle m t -> m ()
class (Ord (Key t), Show (Key t), Show (Entry t), Typeable t, Show t, Pretty t, Pretty (Key t)) => Table t where
- type Key t :: *
- type Entry t :: *
- rep :: t
readOnly :: Monad m => Pretty (Key t) => Handle m -> Handle m t -> Handle m t
fetch :: Monad m => Table t => MonadThrow m => Handle m t -> Key t -> m (Entry t)
fetchList :: Monad m => Handle m t -> [Key t] -> m (Map (Key t) (Entry t))
fetchAll :: Monad m => Handle m t -> m (Map (Key t) (Entry t))
update :: Monad m => Handle m t -> Key t -> (Entry t -> Entry t) -> m ()
insert :: Monad m => Handle m -> Handle m t -> Key t -> Entry t -> m ()
insertList :: Monad m => Handle m -> Handle m t -> [(Key t, Entry t)] -> m ()
delete :: Monad m => Handle m -> Handle m t -> Key t -> m ()
deleteList :: Monad m => Handle m -> Handle m t -> [Key t] -> m ()
purge :: Monad m => Handle m -> Handle m t -> m ()
commit :: Monad m => Handle m -> Handle m t -> m ()
table :: Table t => Handle m t -> t
data Message = Message Feed FeedElement
data Callback = Callback {
- _executable :: FilePath
- _arguments :: [Text]
}

Documentation

data LogLevel Source #

Constructors

Debug
Info
Warning
Error

Instances

Eq LogLevel Source #
Instance details Defined in Imm.Logger Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Ord LogLevel Source #
Instance details Defined in Imm.Logger Methods compare :: LogLevel -> LogLevel -> Ordering # (<) :: LogLevel -> LogLevel -> Bool # (<=) :: LogLevel -> LogLevel -> Bool # (>) :: LogLevel -> LogLevel -> Bool # (>=) :: LogLevel -> LogLevel -> Bool # max :: LogLevel -> LogLevel -> LogLevel # min :: LogLevel -> LogLevel -> LogLevel #
Read LogLevel Source #
Instance details Defined in Imm.Logger Methods readsPrec :: Int -> ReadS LogLevel # readList :: ReadS [LogLevel] # readPrec :: ReadPrec LogLevel # readListPrec :: ReadPrec [LogLevel] #
Show LogLevel Source #
Instance details Defined in Imm.Logger Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Pretty LogLevel Source #
Instance details Defined in Imm.Logger Methods pretty :: LogLevel -> Doc ann # prettyList :: [LogLevel] -> Doc ann #

log :: Handle m -> LogLevel -> Doc AnsiStyle -> m () Source #

getLogLevel :: Handle m -> m LogLevel Source #

setLogLevel :: Handle m -> LogLevel -> m () Source #

setColorizeLogs :: Handle m -> Bool -> m () Source #

flushLogs :: Handle m -> m () Source #

httpGet :: Handle m -> URI -> m LByteString Source #

get :: Monad m => Handle m -> Handle m -> URI -> m LByteString Source #

Simple wrapper around httpGet that also logs the requested URI.

data FeedURI Source #

Constructors

FeedURI (URIRef a)

Instances

Eq FeedURI Source #
Instance details Defined in Imm.Feed Methods (==) :: FeedURI -> FeedURI -> Bool # (/=) :: FeedURI -> FeedURI -> Bool #
Ord FeedURI Source #
Instance details Defined in Imm.Feed Methods compare :: FeedURI -> FeedURI -> Ordering # (<) :: FeedURI -> FeedURI -> Bool # (<=) :: FeedURI -> FeedURI -> Bool # (>) :: FeedURI -> FeedURI -> Bool # (>=) :: FeedURI -> FeedURI -> Bool # max :: FeedURI -> FeedURI -> FeedURI # min :: FeedURI -> FeedURI -> FeedURI #
Show FeedURI Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedURI -> ShowS # show :: FeedURI -> String # showList :: [FeedURI] -> ShowS #

data FeedElement Source #

Constructors

RssElement (RssItem '[ContentModule, DublinCoreModule])
AtomElement AtomEntry

Instances

Eq FeedElement Source #
Instance details Defined in Imm.Feed Methods (==) :: FeedElement -> FeedElement -> Bool # (/=) :: FeedElement -> FeedElement -> Bool #
Ord FeedElement Source #
Instance details Defined in Imm.Feed Methods compare :: FeedElement -> FeedElement -> Ordering # (<) :: FeedElement -> FeedElement -> Bool # (<=) :: FeedElement -> FeedElement -> Bool # (>) :: FeedElement -> FeedElement -> Bool # (>=) :: FeedElement -> FeedElement -> Bool # max :: FeedElement -> FeedElement -> FeedElement # min :: FeedElement -> FeedElement -> FeedElement #
Show FeedElement Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedElement -> ShowS # show :: FeedElement -> String # showList :: [FeedElement] -> ShowS #
Pretty (PrettyKey FeedElement) Source #
Instance details Defined in Imm.Feed Methods pretty :: PrettyKey FeedElement -> Doc ann # prettyList :: [PrettyKey FeedElement] -> Doc ann #

data Feed Source #

Constructors

Rss (RssDocument '[ContentModule, DublinCoreModule])
Atom AtomFeed

Instances

Eq Feed Source #
Instance details Defined in Imm.Feed Methods (==) :: Feed -> Feed -> Bool # (/=) :: Feed -> Feed -> Bool #
Ord Feed Source #
Instance details Defined in Imm.Feed Methods compare :: Feed -> Feed -> Ordering # (<) :: Feed -> Feed -> Bool # (<=) :: Feed -> Feed -> Bool # (>) :: Feed -> Feed -> Bool # (>=) :: Feed -> Feed -> Bool # max :: Feed -> Feed -> Feed # min :: Feed -> Feed -> Feed #
Show Feed Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> Feed -> ShowS # show :: Feed -> String # showList :: [Feed] -> ShowS #

data FeedRef Source #

Feed reference: either its URI, or its UID from database

Constructors

ByUID Int
ByURI URI

Instances

Eq FeedRef Source #
Instance details Defined in Imm.Feed Methods (==) :: FeedRef -> FeedRef -> Bool # (/=) :: FeedRef -> FeedRef -> Bool #
Ord FeedRef Source #
Instance details Defined in Imm.Feed Methods compare :: FeedRef -> FeedRef -> Ordering # (<) :: FeedRef -> FeedRef -> Bool # (<=) :: FeedRef -> FeedRef -> Bool # (>) :: FeedRef -> FeedRef -> Bool # (>=) :: FeedRef -> FeedRef -> Bool # max :: FeedRef -> FeedRef -> FeedRef # min :: FeedRef -> FeedRef -> FeedRef #
Show FeedRef Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedRef -> ShowS # show :: FeedRef -> String # showList :: [FeedRef] -> ShowS #
Pretty FeedRef Source #
Instance details Defined in Imm.Feed Methods pretty :: FeedRef -> Doc ann # prettyList :: [FeedRef] -> Doc ann #

sameURIType :: URIRef a1 -> URIRef a2 -> Maybe (URIRef a1 :~: URIRef a2) Source #

withFeedURI :: (forall a. URIRef a -> b) -> FeedURI -> b Source #

renderFeed :: Feed -> Text Source #

renderFeedElement :: FeedElement -> Text Source #

parseFeed :: MonadCatch m => Text -> m Feed Source #

parseFeedElement :: MonadCatch m => Text -> m FeedElement Source #

removeElements :: Feed -> Feed Source #

getFeedTitle :: Feed -> Text Source #

getElements :: Feed -> [FeedElement] Source #

getDate :: FeedElement -> Maybe UTCTime Source #

getTitle :: FeedElement -> Text Source #

getContent :: FeedElement -> Text Source #

getLink :: FeedElement -> Maybe FeedURI Source #

getId :: FeedElement -> Text Source #

prettyElement :: FeedElement -> Doc a Source #

parseXml :: Handle m -> URI -> LByteString -> m Feed Source #

data DatabaseException t Source #

Constructors

NotCommitted t
NotDeleted t [Key t]
NotFound t [Key t]
NotInserted t [(Key t, Entry t)]
NotPurged t
NotUpdated t (Key t)
UnableFetchAll t

Instances

(Eq t, Eq (Key t), Eq (Entry t)) => Eq (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods (==) :: DatabaseException t -> DatabaseException t -> Bool # (/=) :: DatabaseException t -> DatabaseException t -> Bool #
(Show t, Show (Key t), Show (Entry t)) => Show (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods showsPrec :: Int -> DatabaseException t -> ShowS # show :: DatabaseException t -> String # showList :: [DatabaseException t] -> ShowS #
(Table t, Show (Key t), Show (Entry t), Pretty (Key t), Typeable t) => Exception (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods toException :: DatabaseException t -> SomeException # fromException :: SomeException -> Maybe (DatabaseException t) # displayException :: DatabaseException t -> String #
(Pretty t, Pretty (Key t)) => Pretty (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods pretty :: DatabaseException t -> Doc ann # prettyList :: [DatabaseException t] -> Doc ann #

_describeDatabase :: Handle m t -> m (Doc AnsiStyle) Source #

_fetchList :: Handle m t -> [Key t] -> m (Map (Key t) (Entry t)) Source #

_fetchAll :: Handle m t -> m (Map (Key t) (Entry t)) Source #

_update :: Handle m t -> Key t -> (Entry t -> Entry t) -> m () Source #

_insertList :: Handle m t -> [(Key t, Entry t)] -> m () Source #

_deleteList :: Handle m t -> [Key t] -> m () Source #

_purge :: Handle m t -> m () Source #

_commit :: Handle m t -> m () Source #

class (Ord (Key t), Show (Key t), Show (Entry t), Typeable t, Show t, Pretty t, Pretty (Key t)) => Table t where Source #

Generic database table

Associated Types

type Key t :: * Source #

type Entry t :: * Source #

Methods

rep :: t Source #

Instances

Table FeedTable Source #
Instance details Defined in Imm.Database.FeedTable Associated Types type Key FeedTable :: Type Source # type Entry FeedTable :: Type Source # Methods rep :: FeedTable Source #

readOnly :: Monad m => Pretty (Key t) => Handle m -> Handle m t -> Handle m t Source #

fetch :: Monad m => Table t => MonadThrow m => Handle m t -> Key t -> m (Entry t) Source #

fetchList :: Monad m => Handle m t -> [Key t] -> m (Map (Key t) (Entry t)) Source #

fetchAll :: Monad m => Handle m t -> m (Map (Key t) (Entry t)) Source #

update :: Monad m => Handle m t -> Key t -> (Entry t -> Entry t) -> m () Source #

insert :: Monad m => Handle m -> Handle m t -> Key t -> Entry t -> m () Source #

insertList :: Monad m => Handle m -> Handle m t -> [(Key t, Entry t)] -> m () Source #

delete :: Monad m => Handle m -> Handle m t -> Key t -> m () Source #

deleteList :: Monad m => Handle m -> Handle m t -> [Key t] -> m () Source #

purge :: Monad m => Handle m -> Handle m t -> m () Source #

commit :: Monad m => Handle m -> Handle m t -> m () Source #

table :: Table t => Handle m t -> t Source #

data Message Source #

All information passed to external programs about a new feed item, are stored in this structure.

Constructors

Message Feed FeedElement

Instances

Eq Message Source #
Instance details Defined in Imm.Callback Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Ord Message Source #
Instance details Defined in Imm.Callback Methods compare :: Message -> Message -> Ordering # (<) :: Message -> Message -> Bool # (<=) :: Message -> Message -> Bool # (>) :: Message -> Message -> Bool # (>=) :: Message -> Message -> Bool # max :: Message -> Message -> Message # min :: Message -> Message -> Message #
Show Message Source #
Instance details Defined in Imm.Callback Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Generic Message Source #
Instance details Defined in Imm.Callback Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
ToJSON Message Source #
Instance details Defined in Imm.Callback Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #
FromJSON Message Source #
Instance details Defined in Imm.Callback Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #
type Rep Message Source #
Instance details Defined in Imm.Callback type Rep Message = D1 (MetaData "Message" "Imm.Callback" "imm-1.6.0.0-AI8t4wjrAX18Aalm5NPGfe" False) (C1 (MetaCons "Message" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Feed) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FeedElement)))

data Callback Source #

External program run for each feed element.

A Message is passed to this program through stdin, serialized in JSON.

Constructors

Callback
Fields _executable :: FilePath _arguments :: [Text]

Instances

Eq Callback Source #
Instance details Defined in Imm.Callback Methods (==) :: Callback -> Callback -> Bool # (/=) :: Callback -> Callback -> Bool #
Ord Callback Source #
Instance details Defined in Imm.Callback Methods compare :: Callback -> Callback -> Ordering # (<) :: Callback -> Callback -> Bool # (<=) :: Callback -> Callback -> Bool # (>) :: Callback -> Callback -> Bool # (>=) :: Callback -> Callback -> Bool # max :: Callback -> Callback -> Callback # min :: Callback -> Callback -> Callback #
Read Callback Source #
Instance details Defined in Imm.Callback Methods readsPrec :: Int -> ReadS Callback # readList :: ReadS [Callback] # readPrec :: ReadPrec Callback # readListPrec :: ReadPrec [Callback] #
Show Callback Source #
Instance details Defined in Imm.Callback Methods showsPrec :: Int -> Callback -> ShowS # show :: Callback -> String # showList :: [Callback] -> ShowS #
Generic Callback Source #
Instance details Defined in Imm.Callback Associated Types type Rep Callback :: Type -> Type # Methods from :: Callback -> Rep Callback x # to :: Rep Callback x -> Callback #
Interpret Callback Source #
Instance details Defined in Imm.Callback Methods autoWith :: InterpretOptions -> Type Callback #
Pretty Callback Source #
Instance details Defined in Imm.Callback Methods pretty :: Callback -> Doc ann # prettyList :: [Callback] -> Doc ann #
type Rep Callback Source #
Instance details Defined in Imm.Callback type Rep Callback = D1 (MetaData "Callback" "Imm.Callback" "imm-1.6.0.0-AI8t4wjrAX18Aalm5NPGfe" False) (C1 (MetaCons "Callback" PrefixI True) (S1 (MetaSel (Just "_executable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "_arguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))