Text.RSS.Extensions

Support for RSS extensions. Cf specification at http://web.resource.org/rss/1.0/modules/.

To implement an RSS extension:

• Create a data-type, that will be used as a tag to identify the extension. To allow stacking multiple extensions, your data-type should have kind * -> *

data MyExtension otherExtensions = MyExtension otherExtensions

• Implement extension types for <channel> and <item> elements:

data instance RssChannelExtension (MyExtension e) = MyExtensionChannel
  { -- ... add your fields ...
  , otherChannelExtensions :: RssChannelExtension e
  }

data instance RssItemExtension (MyExtension e) = MyExtensionItem
  { -- ... add your fields ...
  , otherItemExtensions :: RssItemExtension e
  }

• Implement ParseRssExtension and RenderRssExtension type classes:

-- Parser should rely on ZipConduit to be order-insensitive
instance ParseRssExtension e => ParseRssExtension (MyExtension e) where
  parseRssChannelExtension = getZipConduit $ MyExtensionChannel
    <$> ZipConduit -- ... parse fields
    <*> ZipConduit parseRssChannelExtension
  parseRssItemExtension = -- ... similarly

instance RenderRssExtension e => RenderRssExtension (MyExtension e) where
  renderRssChannelExtension (MyExtensionChannel {- fields -} otherChannelExtensions) = do
    -- ... render fields
    renderRssChannelExtension otherChannelExtensions
  renderRssItemExtension (MyExtensionItem {- fields -} otherItemExtensions) = -- ... similarly

Parsing

class ParseRssExtension a where

Class of RSS extensions that can be parsed.

Methods

parseRssChannelExtension :: MonadThrow m => ConduitT Event o m (RssChannelExtension a)

This parser will be fed with all Events within the <channel> element. Therefore, it is expected to ignore Events unrelated to the RSS extension.

parseRssItemExtension :: MonadThrow m => ConduitT Event o m (RssItemExtension a)

This parser will be fed with all Events within the <item> element. Therefore, it is expected to ignore Events unrelated to the RSS extension.

Instances

ParseRssExtension NoExtensions

Defined in Text.RSS.Extensions

Methods

parseRssChannelExtension :: MonadThrow m => ConduitT Event o m (RssChannelExtension NoExtensions)

parseRssItemExtension :: MonadThrow m => ConduitT Event o m (RssItemExtension NoExtensions)

ParseRssExtension a => ParseRssExtension (SyndicationModule a)

Defined in Text.RSS.Extensions.Syndication

Methods

parseRssChannelExtension :: MonadThrow m => ConduitT Event o m (RssChannelExtension (SyndicationModule a))

parseRssItemExtension :: MonadThrow m => ConduitT Event o m (RssItemExtension (SyndicationModule a))

ParseRssExtension a => ParseRssExtension (DublinCoreModule a)

Defined in Text.RSS.Extensions.DublinCore

Methods

parseRssChannelExtension :: MonadThrow m => ConduitT Event o m (RssChannelExtension (DublinCoreModule a))

parseRssItemExtension :: MonadThrow m => ConduitT Event o m (RssItemExtension (DublinCoreModule a))

ParseRssExtension a => ParseRssExtension (ContentModule a)

Defined in Text.RSS.Extensions.Content

Methods

parseRssChannelExtension :: MonadThrow m => ConduitT Event o m (RssChannelExtension (ContentModule a))

parseRssItemExtension :: MonadThrow m => ConduitT Event o m (RssItemExtension (ContentModule a))

ParseRssExtension a => ParseRssExtension (AtomModule a)

Defined in Text.RSS.Extensions.Atom

Methods

parseRssChannelExtension :: MonadThrow m => ConduitT Event o m (RssChannelExtension (AtomModule a))

parseRssItemExtension :: MonadThrow m => ConduitT Event o m (RssItemExtension (AtomModule a))

Rendering

class RenderRssExtension e where

Class of RSS extensions that can be rendered.

Methods

renderRssChannelExtension :: Monad m => RssChannelExtension e -> ConduitT () Event m ()

Render extension for the <channel> element.

renderRssItemExtension :: Monad m => RssItemExtension e -> ConduitT () Event m ()

Render extension for the <item> element.

Instances

RenderRssExtension NoExtensions

Defined in Text.RSS.Extensions

Methods

renderRssChannelExtension :: Monad m => RssChannelExtension NoExtensions -> ConduitT () Event m ()

renderRssItemExtension :: Monad m => RssItemExtension NoExtensions -> ConduitT () Event m ()

RenderRssExtension a => RenderRssExtension (SyndicationModule a)

Defined in Text.RSS.Extensions.Syndication

Methods

renderRssChannelExtension :: Monad m => RssChannelExtension (SyndicationModule a) -> ConduitT () Event m ()

renderRssItemExtension :: Monad m => RssItemExtension (SyndicationModule a) -> ConduitT () Event m ()

RenderRssExtension a => RenderRssExtension (DublinCoreModule a)

Defined in Text.RSS.Extensions.DublinCore

Methods

renderRssChannelExtension :: Monad m => RssChannelExtension (DublinCoreModule a) -> ConduitT () Event m ()

renderRssItemExtension :: Monad m => RssItemExtension (DublinCoreModule a) -> ConduitT () Event m ()

RenderRssExtension a => RenderRssExtension (ContentModule a)

Defined in Text.RSS.Extensions.Content

Methods

renderRssChannelExtension :: Monad m => RssChannelExtension (ContentModule a) -> ConduitT () Event m ()

renderRssItemExtension :: Monad m => RssItemExtension (ContentModule a) -> ConduitT () Event m ()

RenderRssExtension a => RenderRssExtension (AtomModule a)

Defined in Text.RSS.Extensions.Atom

Methods

renderRssChannelExtension :: Monad m => RssChannelExtension (AtomModule a) -> ConduitT () Event m ()

renderRssItemExtension :: Monad m => RssItemExtension (AtomModule a) -> ConduitT () Event m ()