starfeeds

Types

Cloud

pub type Cloud {
  Cloud(
    domain: String,
    port: Int,
    path: String,
    register_procedure: String,
    protocol: String,
  )
}

Constructors

Cloud(
  domain: String,
  port: Int,
  path: String,
  register_procedure: String,
  protocol: String,
)

Enclosure

</>

pub type Enclosure {
  Enclosure(url: String, length: Int, enclosure_type: String)
}

Constructors

Enclosure(url: String, length: Int, enclosure_type: String)

Image

</>

pub type Image {
  Image(
    url: String,
    title: String,
    link: String,
    description: Option(String),
    width: Option(Int),
    height: Option(Int),
  )
}

Constructors

Image(
  url: String,
  title: String,
  link: String,
  description: Option(String),
  width: Option(Int),
  height: Option(Int),
)

JsonAttachment

</>

pub type JsonAttachment {
  JsonAttachment(
    url: String,
    mime_type: String,
    title: String,
    size_in_bytes: Option(Int),
    duration_in_seconds: Option(Int),
  )
}

Constructors

JsonAttachment(
  url: String,
  mime_type: String,
  title: String,
  size_in_bytes: Option(Int),
  duration_in_seconds: Option(Int),
)

JsonAuthor

</>

pub type JsonAuthor {
  JsonAuthor(name: String, url: String, avatar: Option(String))
}

Constructors

JsonAuthor(name: String, url: String, avatar: Option(String))

JsonFeed

</>

pub type JsonFeed {
  JsonFeed(
    version: String,
    title: String,
    home_page_url: Option(String),
    feed_url: Option(String),
    description: Option(String),
    user_comment: Option(String),
    next_url: Option(String),
    icon: Option(String),
    favicon: Option(String),
    authors: List(JsonAuthor),
    language: Option(String),
    expired: Option(Bool),
    items: List(JsonItem),
  )
}

Constructors

JsonFeed(
  version: String,
  title: String,
  home_page_url: Option(String),
  feed_url: Option(String),
  description: Option(String),
  user_comment: Option(String),
  next_url: Option(String),
  icon: Option(String),
  favicon: Option(String),
  authors: List(JsonAuthor),
  language: Option(String),
  expired: Option(Bool),
  items: List(JsonItem),
)

JsonItem

</>

pub type JsonItem {
  JsonItem(
    id: String,
    url: String,
    external_url: Option(String),
    title: String,
    content_html: Option(String),
    content_text: Option(String),
    summary: Option(String),
    image: Option(String),
    banner_image: Option(String),
    date_published: Option(Time),
    date_modified: Option(Time),
    authors: List(JsonAuthor),
    tags: List(String),
    language: Option(String),
    attachments: List(JsonAttachment),
  )
}

Constructors

JsonItem(
  id: String,
  url: String,
  external_url: Option(String),
  title: String,
  content_html: Option(String),
  content_text: Option(String),
  summary: Option(String),
  image: Option(String),
  banner_image: Option(String),
  date_published: Option(Time),
  date_modified: Option(Time),
  authors: List(JsonAuthor),
  tags: List(String),
  language: Option(String),
  attachments: List(JsonAttachment),
)

Link

</>

Link of an Rss Channel

pub type Link {
  Link(
    href: String,
    rel: String,
    link_type: String,
    length: String,
  )
}

Constructors

Link(
  href: String,
  rel: String,
  link_type: String,
  length: String,
)

RssChannel

</>

RSS 2.0. Compliant Spec

pub type RssChannel {
  RssChannel(
    title: String,
    link: String,
    description: String,
    language: Option(String),
    copyright: Option(String),
    managing_editor: Option(String),
    web_master: Option(String),
    pub_date: Option(Time),
    last_build_date: Option(Time),
    categories: List(String),
    generator: Option(String),
    docs: Option(String),
    cloud: Option(Cloud),
    ttl: Option(Int),
    image: Option(Image),
    text_input: Option(TextInput),
    skip_hours: List(Int),
    skip_days: List(birl.Weekday),
    items: List(RssItem),
  )
}

Constructors

RssChannel(
  title: String,
  link: String,
  description: String,
  language: Option(String),
  copyright: Option(String),
  managing_editor: Option(String),
  web_master: Option(String),
  pub_date: Option(Time),
  last_build_date: Option(Time),
  categories: List(String),
  generator: Option(String),
  docs: Option(String),
  cloud: Option(Cloud),
  ttl: Option(Int),
  image: Option(Image),
  text_input: Option(TextInput),
  skip_hours: List(Int),
  skip_days: List(birl.Weekday),
  items: List(RssItem),
)

Arguments

pub_date

Publication Date of the content in RFC 822 Date-time format

RssItem

</>

pub type RssItem {
  RssItem(
    title: String,
    description: String,
    link: Option(String),
    author: Option(String),
    source: Option(String),
    comments: Option(String),
    pub_date: Option(Time),
    categories: List(String),
    enclosure: Option(Enclosure),
    guid: Option(#(String, Option(Bool))),
  )
}

Constructors

RssItem(
  title: String,
  description: String,
  link: Option(String),
  author: Option(String),
  source: Option(String),
  comments: Option(String),
  pub_date: Option(Time),
  categories: List(String),
  enclosure: Option(Enclosure),
  guid: Option(#(String, Option(Bool))),
)

TextInput

</>

pub type TextInput {
  TextInput(
    title: String,
    description: String,
    name: String,
    link: String,
  )
}

Constructors

TextInput(
  title: String,
  description: String,
  name: String,
  link: String,
)

Functions

add_channel_categories

</>

pub fn add_channel_categories(
  channel: RssChannel,
  categories: List(String),
) -> RssChannel

add_channel_category

</>

pub fn add_channel_category(
  channel: RssChannel,
  category: String,
) -> RssChannel

add_channel_cloud

</>

pub fn add_channel_cloud(
  channel: RssChannel,
  cloud: Cloud,
) -> RssChannel

add_channel_copyright

</>

pub fn add_channel_copyright(
  channel: RssChannel,
  copyright: String,
) -> RssChannel

add_channel_docs

</>

pub fn add_channel_docs(channel: RssChannel) -> RssChannel

add_channel_generator

</>

pub fn add_channel_generator(
  channel: RssChannel,
  generator: String,
) -> RssChannel

add_channel_image

</>

pub fn add_channel_image(
  channel: RssChannel,
  image: Image,
) -> RssChannel

add_channel_item

</>

pub fn add_channel_item(
  channel: RssChannel,
  item: RssItem,
) -> RssChannel

add_channel_items

</>

pub fn add_channel_items(
  channel: RssChannel,
  items: List(RssItem),
) -> RssChannel

add_channel_language

</>

pub fn add_channel_language(
  channel: RssChannel,
  language: String,
) -> RssChannel

add_channel_last_build_date

</>

pub fn add_channel_last_build_date(
  channel: RssChannel,
  last_build_date: Time,
) -> RssChannel

add_channel_managing_editor

</>

pub fn add_channel_managing_editor(
  channel: RssChannel,
  managing_editor: String,
) -> RssChannel

add_channel_pub_date

</>

pub fn add_channel_pub_date(
  channel: RssChannel,
  pub_date: Time,
) -> RssChannel

add_channel_skip_days

</>

pub fn add_channel_skip_days(
  channel: RssChannel,
  skip_days: List(Weekday),
) -> RssChannel

add_channel_skip_hours

</>

pub fn add_channel_skip_hours(
  channel: RssChannel,
  skip_hours: List(Int),
) -> RssChannel

add_channel_text_input

</>

pub fn add_channel_text_input(
  channel: RssChannel,
  text_input: TextInput,
) -> RssChannel

add_channel_ttl

</>

pub fn add_channel_ttl(
  channel: RssChannel,
  ttl: Int,
) -> RssChannel

add_channel_web_master

</>

pub fn add_channel_web_master(
  channel: RssChannel,
  web_master: String,
) -> RssChannel

add_item_author

</>

pub fn add_item_author(item: RssItem, author: String) -> RssItem

add_item_categories

</>

pub fn add_item_categories(
  item: RssItem,
  categories: List(String),
) -> RssItem

add_item_comments

</>

pub fn add_item_comments(
  item: RssItem,
  comments: String,
) -> RssItem

add_item_enclosure

</>

pub fn add_item_enclosure(
  item: RssItem,
  enclosure: Enclosure,
) -> RssItem

add_item_guid

</>

pub fn add_item_guid(
  item: RssItem,
  guid: #(String, Option(Bool)),
) -> RssItem

add_item_link

</>

pub fn add_item_link(item: RssItem, link: String) -> RssItem

add_item_pub_date

</>

pub fn add_item_pub_date(
  item: RssItem,
  pub_date: Time,
) -> RssItem

add_item_source

</>

pub fn add_item_source(item: RssItem, source: String) -> RssItem

add_json_item_attachment

</>

pub fn add_json_item_attachment(
  item: JsonItem,
  attachment: JsonAttachment,
) -> JsonItem

add_json_item_attachments

</>

pub fn add_json_item_attachments(
  item: JsonItem,
  attachments: List(JsonAttachment),
) -> JsonItem

add_json_item_author

</>

pub fn add_json_item_author(
  item: JsonItem,
  author: JsonAuthor,
) -> JsonItem

add_json_item_authors

</>

pub fn add_json_item_authors(
  item: JsonItem,
  authors: List(JsonAuthor),
) -> JsonItem

add_json_item_banner_image

</>

pub fn add_json_item_banner_image(
  item: JsonItem,
  banner_image: String,
) -> JsonItem

add_json_item_content_html

</>

pub fn add_json_item_content_html(
  item: JsonItem,
  content_html: String,
) -> JsonItem

add_json_item_content_text

</>

pub fn add_json_item_content_text(
  item: JsonItem,
  content_text: String,
) -> JsonItem

add_json_item_date_modified

</>

pub fn add_json_item_date_modified(
  item: JsonItem,
  date_modified: Time,
) -> JsonItem

add_json_item_date_published

</>

pub fn add_json_item_date_published(
  item: JsonItem,
  date_published: Time,
) -> JsonItem

add_json_item_external_url

</>

pub fn add_json_item_external_url(
  item: JsonItem,
  external_url: String,
) -> JsonItem

add_json_item_image

</>

pub fn add_json_item_image(
  item: JsonItem,
  image: String,
) -> JsonItem

add_json_item_language

</>

pub fn add_json_item_language(
  item: JsonItem,
  language: String,
) -> JsonItem

add_json_item_summary

</>

pub fn add_json_item_summary(
  item: JsonItem,
  summary: String,
) -> JsonItem

add_json_item_tags

</>

pub fn add_json_item_tags(
  item: JsonItem,
  tags: List(String),
) -> JsonItem

json_feed

</>

pub fn json_feed(version: String, title: String) -> JsonFeed

json_feed_to_string

</>

pub fn json_feed_to_string(feed: JsonFeed) -> String

json_item

</>

pub fn json_item(
  id: String,
  url: String,
  title: String,
) -> JsonItem

rss_channel

</>

pub fn rss_channel(
  title: String,
  description: String,
  link: String,
) -> RssChannel

rss_channel_to_xml_string

</>

pub fn rss_channel_to_xml_string(channel: RssChannel) -> String

rss_item

</>

pub fn rss_item(title: String, description: String) -> RssItem

rss_item_to_xml_string

</>

pub fn rss_item_to_xml_string(item: RssItem) -> String

to_xml_string

</>

pub fn to_xml_string(channels: List(RssChannel)) -> String