Imm

Meta-module that reexports many Imm sub-modules.

Documentation

data LogLevel

Constructors

Debug

Info

Warning

Error

Instances

Eq LogLevel

Defined in Imm.Logger

Methods

(==) :: LogLevel -> LogLevel -> Bool

(/=) :: LogLevel -> LogLevel -> Bool

Ord LogLevel

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

Defined in Imm.Logger

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Defined in Imm.Logger

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Pretty LogLevel

Defined in Imm.Logger

Methods

pretty :: LogLevel -> Doc ann

prettyList :: [LogLevel] -> Doc ann

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 ()

_withGet :: Handle m -> forall a. URI -> (Producer' ByteString m () -> m a) -> m a

withGet :: Monad m => Handle m -> Handle m -> URI -> (Producer' ByteString m () -> m a) -> m a

Simple wrapper around _withGet that also logs the requested URI.

data FeedURI

Constructors

FeedURI (URIRef a)

Instances

Eq FeedURI

Defined in Imm.Feed

Methods

(==) :: FeedURI -> FeedURI -> Bool

(/=) :: FeedURI -> FeedURI -> Bool

Ord FeedURI

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

Defined in Imm.Feed

Methods

showsPrec :: Int -> FeedURI -> ShowS

show :: FeedURI -> String

showList :: [FeedURI] -> ShowS

data FeedElement

Constructors

RssElement (RssItem (ContentModule (DublinCoreModule NoExtensions)))

AtomElement AtomEntry

Instances

Eq FeedElement

Defined in Imm.Feed

Methods

(==) :: FeedElement -> FeedElement -> Bool

(/=) :: FeedElement -> FeedElement -> Bool

Ord FeedElement

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

Defined in Imm.Feed

Methods

showsPrec :: Int -> FeedElement -> ShowS

show :: FeedElement -> String

showList :: [FeedElement] -> ShowS

Pretty (PrettyKey FeedElement)

Defined in Imm.Feed

Methods

pretty :: PrettyKey FeedElement -> Doc ann

prettyList :: [PrettyKey FeedElement] -> Doc ann

data Feed

Constructors

Rss (RssDocument (ContentModule (DublinCoreModule NoExtensions)))

Atom AtomFeed

Instances

Eq Feed

Defined in Imm.Feed

Methods

(==) :: Feed -> Feed -> Bool

(/=) :: Feed -> Feed -> Bool

Ord Feed

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

Defined in Imm.Feed

Methods

showsPrec :: Int -> Feed -> ShowS

show :: Feed -> String

showList :: [Feed] -> ShowS

data FeedQuery

A query describes a set of feeds through some criteria.

Constructors

ByDatabaseID Int

ByURI URI

AllFeeds

Instances

Eq FeedQuery

Defined in Imm.Feed

Methods

(==) :: FeedQuery -> FeedQuery -> Bool

(/=) :: FeedQuery -> FeedQuery -> Bool

Ord FeedQuery

Defined in Imm.Feed

Methods

compare :: FeedQuery -> FeedQuery -> Ordering

(<) :: FeedQuery -> FeedQuery -> Bool

(<=) :: FeedQuery -> FeedQuery -> Bool

(>) :: FeedQuery -> FeedQuery -> Bool

(>=) :: FeedQuery -> FeedQuery -> Bool

max :: FeedQuery -> FeedQuery -> FeedQuery

min :: FeedQuery -> FeedQuery -> FeedQuery

Show FeedQuery

Defined in Imm.Feed

Methods

showsPrec :: Int -> FeedQuery -> ShowS

show :: FeedQuery -> String

showList :: [FeedQuery] -> ShowS

Pretty FeedQuery

Defined in Imm.Feed

Methods

pretty :: FeedQuery -> Doc ann

prettyList :: [FeedQuery] -> Doc ann

data FeedLocation

Feed location identifies a feed. It is either: - the feed URI - a webpage URI that refers to the feed through an alternate link, in which case an optional feed title can be provided to disambiguate multiple such links

Constructors

FeedDirectURI URI

FeedAlternateLink URI Text

Instances

Eq FeedLocation

Defined in Imm.Feed

Methods

(==) :: FeedLocation -> FeedLocation -> Bool

(/=) :: FeedLocation -> FeedLocation -> Bool

Ord FeedLocation

Defined in Imm.Feed

Methods

compare :: FeedLocation -> FeedLocation -> Ordering

(<) :: FeedLocation -> FeedLocation -> Bool

(<=) :: FeedLocation -> FeedLocation -> Bool

(>) :: FeedLocation -> FeedLocation -> Bool

(>=) :: FeedLocation -> FeedLocation -> Bool

max :: FeedLocation -> FeedLocation -> FeedLocation

min :: FeedLocation -> FeedLocation -> FeedLocation

Show FeedLocation

Defined in Imm.Feed

Methods

showsPrec :: Int -> FeedLocation -> ShowS

show :: FeedLocation -> String

showList :: [FeedLocation] -> ShowS

ToJSON FeedLocation

Defined in Imm.Feed

Methods

toJSON :: FeedLocation -> Value

toEncoding :: FeedLocation -> Encoding

toJSONList :: [FeedLocation] -> Value

toEncodingList :: [FeedLocation] -> Encoding

FromJSON FeedLocation

Defined in Imm.Feed

Methods

parseJSON :: Value -> Parser FeedLocation

parseJSONList :: Value -> Parser [FeedLocation]

Pretty FeedLocation

Defined in Imm.Feed

Methods

pretty :: FeedLocation -> Doc ann

prettyList :: [FeedLocation] -> Doc ann

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 Callback

External program run for each feed element.

Data is passed to that program through standard input (stdin), using Avro (https://hackage.haskell.org/package/avro) serialization format. The data schema is described in file ids/callback.json, provided with this library.

Constructors

Callback

Fields

• _executable :: FilePath
• _arguments :: [Text]

Instances

Eq Callback

Defined in Imm.Callback

Methods

(==) :: Callback -> Callback -> Bool

(/=) :: Callback -> Callback -> Bool

Ord Callback

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

Defined in Imm.Callback

Methods

readsPrec :: Int -> ReadS Callback

readList :: ReadS [Callback]

readPrec :: ReadPrec Callback

readListPrec :: ReadPrec [Callback]

Show Callback

Defined in Imm.Callback

Methods

showsPrec :: Int -> Callback -> ShowS

show :: Callback -> String

showList :: [Callback] -> ShowS

Generic Callback

Defined in Imm.Callback

Associated Types

type Rep Callback :: Type -> Type

Methods

from :: Callback -> Rep Callback x

to :: Rep Callback x -> Callback

FromDhall Callback

Defined in Imm.Callback

Methods

autoWith :: InputNormalizer -> Decoder Callback

Pretty Callback

Defined in Imm.Callback

Methods

pretty :: Callback -> Doc ann

prettyList :: [Callback] -> Doc ann

type Rep Callback

Defined in Imm.Callback

type Rep Callback = D1 (MetaData "Callback" "Imm.Callback" "imm-1.10.0.0-377OdLQgGSoCHB8Qc5Ycpd" False) (C1 (MetaCons "Callback" PrefixI True) (S1 (MetaSel (Just "_executable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "_arguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

serializeMessage :: Feed -> FeedElement -> LByteString

Meant to be called by the main imm process.

deserializeMessage :: MonadFail m => LByteString -> m (Feed, FeedElement)

Meant to be called by callback process.

data DatabaseException

Constructors

NotCommitted

NotDeleted [FeedLocation]

KeyNotFound [EntryKey]

NotInserted [Entry]

NotPurged

NotUpdated FeedLocation

UnableFetchAll

Instances

Eq DatabaseException

Defined in Imm.Database.Feed

Methods

(==) :: DatabaseException -> DatabaseException -> Bool

(/=) :: DatabaseException -> DatabaseException -> Bool

Show DatabaseException

Defined in Imm.Database.Feed

Methods

showsPrec :: Int -> DatabaseException -> ShowS

show :: DatabaseException -> String

showList :: [DatabaseException] -> ShowS

Exception DatabaseException

Defined in Imm.Database.Feed

Methods

toException :: DatabaseException -> SomeException

fromException :: SomeException -> Maybe DatabaseException

displayException :: DatabaseException -> String

Pretty DatabaseException

Defined in Imm.Database.Feed

Methods

pretty :: DatabaseException -> Doc ann

prettyList :: [DatabaseException] -> Doc ann

_describeDatabase :: Handle m -> m (Doc AnsiStyle)

_fetch :: Handle m -> [EntryKey] -> m (Map EntryKey (Int, Entry))

_fetchAll :: Handle m -> m (Map Int Entry)

_update :: Handle m -> [EntryKey] -> (Entry -> Entry) -> m ()

_insert :: Handle m -> [Entry] -> m (Map FeedLocation Int)

_delete :: Handle m -> [EntryKey] -> m ()

_purge :: Handle m -> m ()

_commit :: Handle m -> m ()

data EntryKey

Constructors

ByLocation FeedLocation

ById Int

Instances

Eq EntryKey

Defined in Imm.Database.Feed

Methods

(==) :: EntryKey -> EntryKey -> Bool

(/=) :: EntryKey -> EntryKey -> Bool

Ord EntryKey

Defined in Imm.Database.Feed

Methods

compare :: EntryKey -> EntryKey -> Ordering

(<) :: EntryKey -> EntryKey -> Bool

(<=) :: EntryKey -> EntryKey -> Bool

(>) :: EntryKey -> EntryKey -> Bool

(>=) :: EntryKey -> EntryKey -> Bool

max :: EntryKey -> EntryKey -> EntryKey

min :: EntryKey -> EntryKey -> EntryKey

Show EntryKey

Defined in Imm.Database.Feed

Methods

showsPrec :: Int -> EntryKey -> ShowS

show :: EntryKey -> String

showList :: [EntryKey] -> ShowS

Pretty EntryKey

Defined in Imm.Database.Feed

Methods

pretty :: EntryKey -> Doc ann

prettyList :: [EntryKey] -> Doc ann

data FeedStatus

Constructors

Unknown

New

LastUpdate UTCTime

Instances

Pretty FeedStatus

Defined in Imm.Database.Feed

Methods

pretty :: FeedStatus -> Doc ann

prettyList :: [FeedStatus] -> Doc ann

data Entry

Constructors

Entry

Fields

• entryLocation :: FeedLocation
• entryTags :: Set Text
• entryReadHashes :: Set Int
• entryFeed :: Maybe Feed
• entryItems :: Map FeedElement Bool
• entryLastUpdate :: Maybe UTCTime

Instances

Eq Entry

Defined in Imm.Database.Feed

Methods

(==) :: Entry -> Entry -> Bool

(/=) :: Entry -> Entry -> Bool

Ord Entry

Defined in Imm.Database.Feed

Methods

compare :: Entry -> Entry -> Ordering

(<) :: Entry -> Entry -> Bool

(<=) :: Entry -> Entry -> Bool

(>) :: Entry -> Entry -> Bool

(>=) :: Entry -> Entry -> Bool

max :: Entry -> Entry -> Entry

min :: Entry -> Entry -> Entry

Show Entry

Defined in Imm.Database.Feed

Methods

showsPrec :: Int -> Entry -> ShowS

show :: Entry -> String

showList :: [Entry] -> ShowS

ToJSON Entry

Defined in Imm.Database.Feed

Methods

toJSON :: Entry -> Value

toEncoding :: Entry -> Encoding

toJSONList :: [Entry] -> Value

toEncodingList :: [Entry] -> Encoding

FromJSON Entry

Defined in Imm.Database.Feed

Methods

parseJSON :: Value -> Parser Entry

parseJSONList :: Value -> Parser [Entry]

newtype JsonElement

Newtype wrapper to provide FromJSON and ToJSON instances for FeedElement

Constructors

JsonElement

Fields

• unwrapElement :: FeedElement

Instances

Eq JsonElement

Defined in Imm.Database.Feed

Methods

(==) :: JsonElement -> JsonElement -> Bool

(/=) :: JsonElement -> JsonElement -> Bool

Ord JsonElement

Defined in Imm.Database.Feed

Methods

compare :: JsonElement -> JsonElement -> Ordering

(<) :: JsonElement -> JsonElement -> Bool

(<=) :: JsonElement -> JsonElement -> Bool

(>) :: JsonElement -> JsonElement -> Bool

(>=) :: JsonElement -> JsonElement -> Bool

max :: JsonElement -> JsonElement -> JsonElement

min :: JsonElement -> JsonElement -> JsonElement

ToJSON JsonElement

Defined in Imm.Database.Feed

Methods

toJSON :: JsonElement -> Value

toEncoding :: JsonElement -> Encoding

toJSONList :: [JsonElement] -> Value

toEncodingList :: [JsonElement] -> Encoding

ToJSONKey JsonElement

Defined in Imm.Database.Feed

Methods

toJSONKey :: ToJSONKeyFunction JsonElement

toJSONKeyList :: ToJSONKeyFunction [JsonElement]

FromJSON JsonElement

Defined in Imm.Database.Feed

Methods

parseJSON :: Value -> Parser JsonElement

parseJSONList :: Value -> Parser [JsonElement]

FromJSONKey JsonElement

Defined in Imm.Database.Feed

Methods

fromJSONKey :: FromJSONKeyFunction JsonElement

fromJSONKeyList :: FromJSONKeyFunction [JsonElement]

getHashes :: FeedElement -> [Int]

prettyShortEntry :: Entry -> Doc AnsiStyle

prettyEntry :: Entry -> Doc AnsiStyle

makeEntry :: FeedLocation -> Set Text -> Entry

matching :: FeedQuery -> Int -> Entry -> Bool

readOnly :: Monad m => Handle m -> Handle m -> Handle m

fetch1 :: Monad m => MonadThrow m => Handle m -> EntryKey -> m (Int, Entry)

fetch :: Monad m => Handle m -> [EntryKey] -> m (Map EntryKey (Int, Entry))

fetchQuery :: Monad m => Handle m -> (Int -> Entry -> Bool) -> m (Map Int Entry)

fetchAll :: Monad m => Handle m -> m (Map Int Entry)

update :: Monad m => Handle m -> [EntryKey] -> (Entry -> Entry) -> m ()

insert :: MonadThrow m => Handle m -> Handle m -> Entry -> m Int

insertList :: Monad m => Handle m -> Handle m -> [Entry] -> m (Map FeedLocation Int)

delete1 :: Monad m => Handle m -> Handle m -> EntryKey -> m ()

delete :: Monad m => Handle m -> Handle m -> [EntryKey] -> m ()

purge :: Monad m => Handle m -> Handle m -> m ()

commit :: Monad m => Handle m -> Handle m -> m ()

register :: MonadThrow m => Handle m -> Handle m -> FeedLocation -> Set Text -> m Int

getStatus :: MonadCatch m => Handle m -> EntryKey -> m FeedStatus

markAsProcessed :: MonadThrow m => MonadTime m => Handle m -> Handle m -> EntryKey -> FeedElement -> m ()

markAsUnprocessed :: MonadThrow m => Handle m -> Handle m -> EntryKey -> m ()

listUnprocessedElements :: MonadThrow m => Handle m -> EntryKey -> m [FeedElement]

isRead :: MonadCatch m => Handle m -> EntryKey -> FeedElement -> m Bool

resolveEntryKey :: Monad m => Handle m -> FeedQuery -> m [EntryKey]

resolveFeedLocation :: Monad m => Handle m -> EntryKey -> m FeedLocation