Safe Haskell	None
Language	Haskell2010

Imm.Feed

Contents

Types
Generic parsers/renderers
Generic mutators
Generic getters
Misc

Description

Helpers to manipulate feeds

Synopsis

data FeedLocation
- = FeedDirectURI URI
- | FeedAlternateLink URI Text
data FeedQuery
- = ByDatabaseID Int
- | ByURI URI
- | AllFeeds
data Feed
- = Rss (RssDocument (ContentModule (DublinCoreModule NoExtensions)))
- | Atom AtomFeed
data FeedElement
- = RssElement (RssItem (ContentModule (DublinCoreModule NoExtensions)))
- | AtomElement AtomEntry
data FeedURI = FeedURI (URIRef a)
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

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

FeedDirectURI URI
FeedAlternateLink URI Text

Instances

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 #
Show FeedLocation Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedLocation -> ShowS # show :: FeedLocation -> String # showList :: [FeedLocation] -> ShowS #
ToJSON FeedLocation Source #
Instance details Defined in Imm.Feed Methods toJSON :: FeedLocation -> Value # toEncoding :: FeedLocation -> Encoding # toJSONList :: [FeedLocation] -> Value # toEncodingList :: [FeedLocation] -> Encoding #
FromJSON FeedLocation Source #
Instance details Defined in Imm.Feed Methods parseJSON :: Value -> Parser FeedLocation # parseJSONList :: Value -> Parser [FeedLocation] #
Pretty FeedLocation Source #
Instance details Defined in Imm.Feed Methods pretty :: FeedLocation -> Doc ann # prettyList :: [FeedLocation] -> Doc ann #

data FeedQuery Source #

A query describes a set of feeds through some criteria.

Constructors

ByDatabaseID Int
ByURI URI
AllFeeds

Instances

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 #
Show FeedQuery Source #
Instance details Defined in Imm.Feed Methods showsPrec :: Int -> FeedQuery -> ShowS # show :: FeedQuery -> String # showList :: [FeedQuery] -> ShowS #
Pretty FeedQuery Source #
Instance details Defined in Imm.Feed Methods pretty :: FeedQuery -> Doc ann # prettyList :: [FeedQuery] -> Doc ann #

data Feed Source #

Constructors

Rss (RssDocument (ContentModule (DublinCoreModule NoExtensions)))
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 FeedElement Source #

Constructors

RssElement (RssItem (ContentModule (DublinCoreModule NoExtensions)))
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 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 #