Fiet v0.3.0 Fiet.RSS2.Engine behaviour View Source

A module to be used to implement RSS 2.0 parser.

Examples

A RSS 2.0 compliant parser can be implemented with:

defmodule StandardParser do
  use Fiet.RSS2.Engine
end

Parsers can also be customized by using :extras option, with :channel being all the outstanding tags in <channel> and :item being all the outstanding tags in <item> in the feed.

defmodule NotSoStardardParser do
  use Fiet.RSS2.Engine, [extras: [
    channel: [{"atom:link", "atom:link"}],
    item: [{"content:encoded", "encoded_content"}]
  ]]
end

Link to this section Summary

Callbacks

parse(document)

Parses RSS 2.0 document.

Link to this section Callbacks

parse(document)

Specs

parse(document :: binary()) :: {:ok, Fiet.RSS2.t()} | {:error, any()}

Parses RSS 2.0 document.

This function accepts RSS 2.0 document in raw binary and returns {:ok, Fiet.RSS2.t()}, {:error, any} otherwise.