Safe Haskell	Safe-Inferred
Language	Haskell2010

Imm.Feed

Contents

Types
Parsers
Utilities

Description

Feed data structures.

Synopsis

data FeedLocation = FeedLocation URI Text
type UID = Int
data FeedQuery
- = QueryByUID UID
- | QueryAll
newtype FeedDefinition = FeedDefinition {
- _feedTitle :: Text
}
data FeedItem = FeedItem {
- _itemDate :: Maybe UTCTime
- _itemTitle :: Text
- _itemContent :: Text
- _itemLinks :: [Link]
- _itemIdentifier :: Text
- _itemAuthors :: [Author]
}
data Author = Author {
- _authorName :: Text
- _authorEmail :: Text
- _authorURI :: Maybe AnyURI
}
parseFeed :: MonadCatch m => Text -> m (FeedDefinition, [FeedItem])
feedC :: MonadCatch m => ConduitT Event o m (Maybe (FeedDefinition, [FeedItem]))
parseFeedItem :: MonadCatch m => Text -> m FeedItem
getMainLink :: FeedItem -> Maybe Link
areSameItem :: FeedItem -> FeedItem -> Bool

Types

data FeedLocation Source #

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

FeedLocation URI Text

Instances

Instances details

FromJSON FeedLocation Source #
Instance details Defined in Imm.Feed Methods parseJSON :: Value -> Parser FeedLocation # parseJSONList :: Value -> Parser [FeedLocation] # omittedField :: Maybe FeedLocation #
ToJSON FeedLocation Source #
Instance details Defined in Imm.Feed Methods toJSON :: FeedLocation -> Value # toEncoding :: FeedLocation -> Encoding # toJSONList :: [FeedLocation] -> Value # toEncodingList :: [FeedLocation] -> Encoding # omitField :: FeedLocation -> Bool #
Generic FeedLocation Source #
Instance details Defined in Imm.Feed Associated Types type Rep FeedLocation :: Type -> Type # Methods from :: FeedLocation -> Rep FeedLocation x # to :: Rep FeedLocation x -> FeedLocation #
Show FeedLocation Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedLocation -> ShowS # show :: FeedLocation -> String # showList :: [FeedLocation] -> ShowS #
Eq FeedLocation Source #
Instance details Defined in Imm.Feed Methods (==) :: FeedLocation -> FeedLocation -> Bool # (/=) :: FeedLocation -> FeedLocation -> Bool #
Ord FeedLocation Source #
Instance details 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 #
Pretty FeedLocation Source #
Instance details Defined in Imm.Feed Methods pretty :: FeedLocation -> Doc ann # prettyList :: [FeedLocation] -> Doc ann #
type Rep FeedLocation Source #
Instance details Defined in Imm.Feed type Rep FeedLocation = D1 ('MetaData "FeedLocation" "Imm.Feed" "imm-2.1.2.0-D2NMr4mlUE8FsGQYPYqh5Y" 'False) (C1 ('MetaCons "FeedLocation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URI) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type UID = Int Source #

Database identifier for a feed

data FeedQuery Source #

A query describes a set of feeds through some criteria.

Constructors

QueryByUID UID
QueryAll

Instances

Instances details

Read FeedQuery Source #
Instance details Defined in Imm.Feed Methods readsPrec :: Int -> ReadS FeedQuery # readList :: ReadS [FeedQuery] # readPrec :: ReadPrec FeedQuery # readListPrec :: ReadPrec [FeedQuery] #
Show FeedQuery Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedQuery -> ShowS # show :: FeedQuery -> String # showList :: [FeedQuery] -> ShowS #
Eq FeedQuery Source #
Instance details Defined in Imm.Feed Methods (==) :: FeedQuery -> FeedQuery -> Bool # (/=) :: FeedQuery -> FeedQuery -> Bool #
Ord FeedQuery Source #
Instance details 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 #
Pretty FeedQuery Source #
Instance details Defined in Imm.Feed Methods pretty :: FeedQuery -> Doc ann # prettyList :: [FeedQuery] -> Doc ann #

newtype FeedDefinition Source #

Constructors

FeedDefinition
Fields _feedTitle :: Text

Instances

Instances details

FromJSON FeedDefinition Source #
Instance details Defined in Imm.Feed Methods parseJSON :: Value -> Parser FeedDefinition # parseJSONList :: Value -> Parser [FeedDefinition] # omittedField :: Maybe FeedDefinition #
ToJSON FeedDefinition Source #
Instance details Defined in Imm.Feed Methods toJSON :: FeedDefinition -> Value # toEncoding :: FeedDefinition -> Encoding # toJSONList :: [FeedDefinition] -> Value # toEncodingList :: [FeedDefinition] -> Encoding # omitField :: FeedDefinition -> Bool #
Generic FeedDefinition Source #
Instance details Defined in Imm.Feed Associated Types type Rep FeedDefinition :: Type -> Type # Methods from :: FeedDefinition -> Rep FeedDefinition x # to :: Rep FeedDefinition x -> FeedDefinition #
Read FeedDefinition Source #
Instance details Defined in Imm.Feed Methods readsPrec :: Int -> ReadS FeedDefinition # readList :: ReadS [FeedDefinition] # readPrec :: ReadPrec FeedDefinition # readListPrec :: ReadPrec [FeedDefinition] #
Show FeedDefinition Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedDefinition -> ShowS # show :: FeedDefinition -> String # showList :: [FeedDefinition] -> ShowS #
Eq FeedDefinition Source #
Instance details Defined in Imm.Feed Methods (==) :: FeedDefinition -> FeedDefinition -> Bool # (/=) :: FeedDefinition -> FeedDefinition -> Bool #
Ord FeedDefinition Source #
Instance details Defined in Imm.Feed Methods compare :: FeedDefinition -> FeedDefinition -> Ordering # (<) :: FeedDefinition -> FeedDefinition -> Bool # (<=) :: FeedDefinition -> FeedDefinition -> Bool # (>) :: FeedDefinition -> FeedDefinition -> Bool # (>=) :: FeedDefinition -> FeedDefinition -> Bool # max :: FeedDefinition -> FeedDefinition -> FeedDefinition # min :: FeedDefinition -> FeedDefinition -> FeedDefinition #
Pretty FeedDefinition Source #
Instance details Defined in Imm.Feed Methods pretty :: FeedDefinition -> Doc ann # prettyList :: [FeedDefinition] -> Doc ann #
Pretty (PrettyName FeedDefinition) Source #
Instance details Defined in Imm.Feed Methods pretty :: PrettyName FeedDefinition -> Doc ann # prettyList :: [PrettyName FeedDefinition] -> Doc ann #
type Rep FeedDefinition Source #
Instance details Defined in Imm.Feed type Rep FeedDefinition = D1 ('MetaData "FeedDefinition" "Imm.Feed" "imm-2.1.2.0-D2NMr4mlUE8FsGQYPYqh5Y" 'True) (C1 ('MetaCons "FeedDefinition" 'PrefixI 'True) (S1 ('MetaSel ('Just "_feedTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data FeedItem Source #

Constructors

FeedItem
Fields _itemDate :: Maybe UTCTime _itemTitle :: Text _itemContent :: Text _itemLinks :: [Link] _itemIdentifier :: Text _itemAuthors :: [Author]

Instances

Instances details

FromJSON FeedItem Source #
Instance details Defined in Imm.Feed Methods parseJSON :: Value -> Parser FeedItem # parseJSONList :: Value -> Parser [FeedItem] # omittedField :: Maybe FeedItem #
ToJSON FeedItem Source #
Instance details Defined in Imm.Feed Methods toJSON :: FeedItem -> Value # toEncoding :: FeedItem -> Encoding # toJSONList :: [FeedItem] -> Value # toEncodingList :: [FeedItem] -> Encoding # omitField :: FeedItem -> Bool #
Generic FeedItem Source #
Instance details Defined in Imm.Feed Associated Types type Rep FeedItem :: Type -> Type # Methods from :: FeedItem -> Rep FeedItem x # to :: Rep FeedItem x -> FeedItem #
Show FeedItem Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedItem -> ShowS # show :: FeedItem -> String # showList :: [FeedItem] -> ShowS #
Eq FeedItem Source #
Instance details Defined in Imm.Feed Methods (==) :: FeedItem -> FeedItem -> Bool # (/=) :: FeedItem -> FeedItem -> Bool #
Ord FeedItem Source #
Instance details Defined in Imm.Feed Methods compare :: FeedItem -> FeedItem -> Ordering # (<) :: FeedItem -> FeedItem -> Bool # (<=) :: FeedItem -> FeedItem -> Bool # (>) :: FeedItem -> FeedItem -> Bool # (>=) :: FeedItem -> FeedItem -> Bool # max :: FeedItem -> FeedItem -> FeedItem # min :: FeedItem -> FeedItem -> FeedItem #
Pretty FeedItem Source #
Instance details Defined in Imm.Feed Methods pretty :: FeedItem -> Doc ann # prettyList :: [FeedItem] -> Doc ann #
Pretty (PrettyName FeedItem) Source #
Instance details Defined in Imm.Feed Methods pretty :: PrettyName FeedItem -> Doc ann # prettyList :: [PrettyName FeedItem] -> Doc ann #
type Rep FeedItem Source #
Instance details Defined in Imm.Feed type Rep FeedItem = D1 ('MetaData "FeedItem" "Imm.Feed" "imm-2.1.2.0-D2NMr4mlUE8FsGQYPYqh5Y" 'False) (C1 ('MetaCons "FeedItem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_itemDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)) :: (S1 ('MetaSel ('Just "_itemTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "_itemContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: (S1 ('MetaSel ('Just "_itemLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Link]) :: (S1 ('MetaSel ('Just "_itemIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_itemAuthors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Author])))))

data Author Source #

Constructors

Author
Fields _authorName :: Text _authorEmail :: Text _authorURI :: Maybe AnyURI

Instances

Instances details

FromJSON Author Source #
Instance details Defined in Imm.Feed Methods parseJSON :: Value -> Parser Author # parseJSONList :: Value -> Parser [Author] # omittedField :: Maybe Author #
ToJSON Author Source #
Instance details Defined in Imm.Feed Methods toJSON :: Author -> Value # toEncoding :: Author -> Encoding # toJSONList :: [Author] -> Value # toEncodingList :: [Author] -> Encoding # omitField :: Author -> Bool #
Generic Author Source #
Instance details Defined in Imm.Feed Associated Types type Rep Author :: Type -> Type # Methods from :: Author -> Rep Author x # to :: Rep Author x -> Author #
Show Author Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> Author -> ShowS # show :: Author -> String # showList :: [Author] -> ShowS #
Eq Author Source #
Instance details Defined in Imm.Feed Methods (==) :: Author -> Author -> Bool # (/=) :: Author -> Author -> Bool #
Ord Author Source #
Instance details Defined in Imm.Feed Methods compare :: Author -> Author -> Ordering # (<) :: Author -> Author -> Bool # (<=) :: Author -> Author -> Bool # (>) :: Author -> Author -> Bool # (>=) :: Author -> Author -> Bool # max :: Author -> Author -> Author # min :: Author -> Author -> Author #
Pretty Author Source #
Instance details Defined in Imm.Feed Methods pretty :: Author -> Doc ann # prettyList :: [Author] -> Doc ann #
type Rep Author Source #
Instance details Defined in Imm.Feed type Rep Author = D1 ('MetaData "Author" "Imm.Feed" "imm-2.1.2.0-D2NMr4mlUE8FsGQYPYqh5Y" 'False) (C1 ('MetaCons "Author" 'PrefixI 'True) (S1 ('MetaSel ('Just "_authorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "_authorEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "_authorURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AnyURI)))))

Parsers

parseFeed :: MonadCatch m => Text -> m (FeedDefinition, [FeedItem]) Source #

feedC :: MonadCatch m => ConduitT Event o m (Maybe (FeedDefinition, [FeedItem])) Source #

Conduit version of parseFeed

parseFeedItem :: MonadCatch m => Text -> m FeedItem Source #

Utilities

getMainLink :: FeedItem -> Maybe Link Source #

areSameItem :: FeedItem -> FeedItem -> Bool Source #