| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Text.RSS.Types
Contents
Description
RSS is an XML dialect for Web content syndication.
Example:
<?xml version="1.0"?>
<rss version="2.0">
<channel>
<title>Liftoff News</title>
<link>http://liftoff.msfc.nasa.gov/</link>
<description>Liftoff to Space Exploration.</description>
<language>en-us</language>
<pubDate>Tue, 10 Jun 2003 04:00:00 GMT</pubDate>
<lastBuildDate>Tue, 10 Jun 2003 09:41:01 GMT</lastBuildDate>
<docs>http://blogs.law.harvard.edu/tech/rss</docs>
<generator>Weblog Editor 2.0</generator>
<managingEditor>editor@example.com</managingEditor>
<webMaster>webmaster@example.com</webMaster>
<item>
<title>Star City</title>
<link>http://liftoff.msfc.nasa.gov/news/2003/news-starcity.asp</link>
<description>How do Americans get ready to work with Russians aboard the International Space Station? They take a crash course in culture, language and protocol at Russia's <a href="http://howe.iki.rssi.ru/GCTC/gctc_e.htm">Star City</a>.</description>
<pubDate>Tue, 03 Jun 2003 09:39:21 GMT</pubDate>
<guid>http://liftoff.msfc.nasa.gov/2003/06/03.html#item573</guid>
</item>
</channel>
</rss>Synopsis
- data RssException
- data RssURI = RssURI (URIRef a)
- withRssURI :: (forall a. URIRef a -> b) -> RssURI -> b
- data RssCategory = RssCategory {}
- data RssEnclosure = RssEnclosure {}
- data RssSource = RssSource {
- sourceUrl :: RssURI
- sourceName :: Text
- data RssGuid
- data RssItem (extensions :: [*]) = RssItem {
- itemTitle :: Text
- itemLink :: Maybe RssURI
- itemDescription :: Text
- itemAuthor :: Text
- itemCategories :: [RssCategory]
- itemComments :: Maybe RssURI
- itemEnclosure :: [RssEnclosure]
- itemGuid :: Maybe RssGuid
- itemPubDate :: Maybe UTCTime
- itemSource :: Maybe RssSource
- itemExtensions :: RssItemExtensions extensions
- type RssItem' = RssItem '[]
- data RssTextInput = RssTextInput {}
- data CloudProtocol
- data RssCloud = RssCloud {}
- data RssImage = RssImage {
- imageUri :: RssURI
- imageTitle :: Text
- imageLink :: RssURI
- imageWidth :: Maybe Int
- imageHeight :: Maybe Int
- imageDescription :: Text
- newtype Hour = Hour Int
- asHour :: MonadThrow m => Int -> m Hour
- data Day
- asDay :: MonadThrow m => Text -> m Day
- data RssDocument (extensions :: [*]) = RssDocument {
- documentVersion :: Version
- channelTitle :: Text
- channelLink :: RssURI
- channelDescription :: Text
- channelItems :: [RssItem extensions]
- channelLanguage :: Text
- channelCopyright :: Text
- channelManagingEditor :: Text
- channelWebmaster :: Text
- channelPubDate :: Maybe UTCTime
- channelLastBuildDate :: Maybe UTCTime
- channelCategories :: [RssCategory]
- channelGenerator :: Text
- channelDocs :: Maybe RssURI
- channelCloud :: Maybe RssCloud
- channelTtl :: Maybe Int
- channelImage :: Maybe RssImage
- channelRating :: Text
- channelTextInput :: Maybe RssTextInput
- channelSkipHours :: Set Hour
- channelSkipDays :: Set Day
- channelExtensions :: RssChannelExtensions extensions
- type RssDocument' = RssDocument '[]
- data family RssChannelExtension extensionTag :: *
- data family RssItemExtension extensionTag :: *
- data family RssChannelExtensions (extensionTags :: [*]) :: *
- data family RssItemExtensions (extensionTags :: [*]) :: *
RSS core
data RssException #
Constructors
| InvalidBool Text | |
| InvalidDay Text | |
| InvalidHour Int | |
| InvalidInt Text | |
| InvalidURI URIParseError | |
| InvalidVersion Text | |
| InvalidProtocol Text | |
| InvalidTime Text | |
| MissingElement Text |
Instances
withRssURI :: (forall a. URIRef a -> b) -> RssURI -> b #
data RssCategory #
The <category> element.
Constructors
| RssCategory | |
Fields
| |
Instances
data RssEnclosure #
The <enclosure> element.
Constructors
| RssEnclosure | |
Fields
| |
Instances
The <source> element.
Constructors
| RssSource | |
Fields
| |
Instances
| Eq RssSource # | |
| Ord RssSource # | |
| Show RssSource # | |
| Generic RssSource # | |
| type Rep RssSource # | |
Defined in Text.RSS.Types type Rep RssSource = D1 (MetaData "RssSource" "Text.RSS.Types" "rss-conduit-0.4.2.1-BJxDIGJRiAtCDNuLIlMXje" False) (C1 (MetaCons "RssSource" PrefixI True) (S1 (MetaSel (Just "sourceUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RssURI) :*: S1 (MetaSel (Just "sourceName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) | |
The <guid> element.
Instances
| Eq RssGuid # | |
| Ord RssGuid # | |
| Show RssGuid # | |
| Generic RssGuid # | |
| type Rep RssGuid # | |
Defined in Text.RSS.Types type Rep RssGuid = D1 (MetaData "RssGuid" "Text.RSS.Types" "rss-conduit-0.4.2.1-BJxDIGJRiAtCDNuLIlMXje" False) (C1 (MetaCons "GuidText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "GuidUri" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RssURI))) | |
data RssItem (extensions :: [*]) #
The <item> element.
This type is open to extensions.
Constructors
| RssItem | |
Fields
| |
Instances
data RssTextInput #
The <textInput> element.
Constructors
| RssTextInput | |
Fields | |
Instances
data CloudProtocol #
Constructors
| ProtocolXmlRpc | |
| ProtocolSoap | |
| ProtocolHttpPost |
Instances
The <cloud> element.
Constructors
| RssCloud | |
Fields | |
Instances
| Eq RssCloud # | |
| Ord RssCloud # | |
Defined in Text.RSS.Types | |
| Show RssCloud # | |
| Generic RssCloud # | |
| type Rep RssCloud # | |
Defined in Text.RSS.Types type Rep RssCloud = D1 (MetaData "RssCloud" "Text.RSS.Types" "rss-conduit-0.4.2.1-BJxDIGJRiAtCDNuLIlMXje" False) (C1 (MetaCons "RssCloud" PrefixI True) (S1 (MetaSel (Just "cloudUri") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RssURI) :*: (S1 (MetaSel (Just "cloudRegisterProcedure") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "cloudProtocol") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CloudProtocol)))) | |
The <image> element.
Constructors
| RssImage | |
Fields
| |
Instances
| Eq RssImage # | |
| Ord RssImage # | |
Defined in Text.RSS.Types | |
| Show RssImage # | |
| Generic RssImage # | |
| type Rep RssImage # | |
Defined in Text.RSS.Types type Rep RssImage = D1 (MetaData "RssImage" "Text.RSS.Types" "rss-conduit-0.4.2.1-BJxDIGJRiAtCDNuLIlMXje" False) (C1 (MetaCons "RssImage" PrefixI True) ((S1 (MetaSel (Just "imageUri") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RssURI) :*: (S1 (MetaSel (Just "imageTitle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "imageLink") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RssURI))) :*: (S1 (MetaSel (Just "imageWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 (MetaSel (Just "imageHeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "imageDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))) | |
Instances
| Bounded Day # | |
| Enum Day # | |
| Eq Day # | |
| Ord Day # | |
| Read Day # | |
| Show Day # | |
| Generic Day # | |
| type Rep Day # | |
Defined in Text.RSS.Types type Rep Day = D1 (MetaData "Day" "Text.RSS.Types" "rss-conduit-0.4.2.1-BJxDIGJRiAtCDNuLIlMXje" False) ((C1 (MetaCons "Monday" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Tuesday" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Wednesday" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "Thursday" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Friday" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "Saturday" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Sunday" PrefixI False) (U1 :: * -> *)))) | |
data RssDocument (extensions :: [*]) #
The <rss> element.
This type is open to extensions.
Constructors
| RssDocument | |
Fields
| |
Instances
type RssDocument' = RssDocument '[] #
Alias for RssDocument with no RSS extensions.
RSS extensions
To implement an RSS extension:
- Create a void data-type, that will be used as a tag to identify the extension:
data MyExtension :: *
- Implement extension types for
<channel>and<item>elements:
data instance RssChannelExtension MyExtension = MyExtensionChannel { {- ... fields -} }
data instance RssItemExtension MyExtension = MyExtensionItem { {- ... fields -} }- Implement corresponding parsers (cf Text.RSS.Extensions).
data family RssChannelExtension extensionTag :: * #
<channel> extension type.
Instances
data family RssItemExtension extensionTag :: * #
<item> extension type.
Instances
data family RssChannelExtensions (extensionTags :: [*]) :: * #
Combination of multiple <channel> extensions.
Instances
data family RssItemExtensions (extensionTags :: [*]) :: * #
Combination of multiple <item> extensions.