glrss_parser/rss

Look at https://www.rssboard.org/rss-specification or https://www.w3schools.com/xml/xml_rss.asp for more information.

The tags and attributes should mostly match the names here.

Types

Channel

pub type Channel {
  Channel(
    title: String,
    link: String,
    description: String,
    language: O(String),
    copyright: O(String),
    managing_editor: O(String),
    web_master: O(String),
    pub_date: O(date.RssDate),
    last_build_date: O(date.RssDate),
    category: O(Category),
    generator: O(String),
    docs: O(String),
    cloud: O(Cloud),
    ttl: O(Int),
    image: O(Image),
    rating: O(String),
    text_input: O(TextInput),
    skip_hours: List(Int),
    skip_days: List(date.DayOfWeek),
    item: List(Item),
  )
}

Constructors

Channel(
  title: String,
  link: String,
  description: String,
  language: O(String),
  copyright: O(String),
  managing_editor: O(String),
  web_master: O(String),
  pub_date: O(date.RssDate),
  last_build_date: O(date.RssDate),
  category: O(Category),
  generator: O(String),
  docs: O(String),
  cloud: O(Cloud),
  ttl: O(Int),
  image: O(Image),
  rating: O(String),
  text_input: O(TextInput),
  skip_hours: List(Int),
  skip_days: List(date.DayOfWeek),
  item: List(Item),
)

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, type_: String)
}

Constructors

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

Image

</>

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

Constructors

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

Item

</>

pub type Item {
  Item(
    title: O(String),
    link: O(String),
    description: O(String),
    author: O(String),
    category: O(Category),
    comments: O(String),
    enclosure: O(Enclosure),
    guid: O(String),
    pub_date: O(date.RssDate),
    source: O(Source),
  )
}

Constructors

Item(
  title: O(String),
  link: O(String),
  description: O(String),
  author: O(String),
  category: O(Category),
  comments: O(String),
  enclosure: O(Enclosure),
  guid: O(String),
  pub_date: O(date.RssDate),
  source: O(Source),
)

ParseError

</>

pub type ParseError {
  UnexpectedSignal(xm.Signal)
  UnexpectedAttribute(List(xm.Attribute))
  UnexpectedData(String)
  XmlmError(xm.InputError)
  PartyError(party.ParseError(PErr))
  NilError
}

Constructors

```
UnexpectedSignal(xm.Signal)
```
```
UnexpectedAttribute(List(xm.Attribute))
```
```
UnexpectedData(String)
```
```
XmlmError(xm.InputError)
```
```
PartyError(party.ParseError(PErr))
```
```
NilError
```

Rss

</>

pub type Rss {
  Rss(version: String, channel: Channel)
}

Constructors

```
Rss(version: String, channel: Channel)
```

Source

</>

pub type Source {
  Source(url: String, name: O(String))
}

Constructors

```
Source(url: String, name: O(String))
```

TextInput

</>

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

Constructors

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

Functions

empty_rss

</>

pub fn empty_rss() -> Rss

parse

</>

pub fn parse(
  rss_xml: String,
  skip_unknown_tags skip: Bool,
) -> Result(Rss, ParseError)

parse_bits

</>

pub fn parse_bits(
  rss_xml: BitArray,
  skip_unknown_tags skip: Bool,
) -> Result(Rss, ParseError)