rss

Library for serializing the RSS web content syndication format.

Supported Versions

Reading from the following RSS versions is supported:

• RSS 0.90
• RSS 0.91
• RSS 0.92
• RSS 1.0
• RSS 2.0

Writing support is limited to RSS 2.0.

Documentation

• Released
• Master

Usage

Add the dependency to your Cargo.toml.

toml [dependencies] rss = "0.6"

The package includes a single crate named rss.

rust extern crate rss;

Reading

From a BufRead

A channel can be read from any object that implements the BufRead trait.

```rust use std::fs::File; use std::io::BufReader; use rss::Channel;

let file = File::open("tests/data/rss2sample.xml").unwrap(); let reader = BufReader::new(file); let channel = Channel::read_from(reader).unwrap(); ```

From a URL

A channel can also be read from a URL.

To enable this functionality you must enable the from_url feature in your Cargo.toml.

toml [dependencies] rss = { version = "*", features = ["from_url"] }

```rust use rss::Channel;

let channel = Channel::from_url("https://feedpress.me/usererror.xml").unwrap(); ```

Writing

A channel can be written to any object that implements the Write trait or converted to an XML string using the ToString trait.

Note: Writing a channel does not perform any escaping of XML entities.

Example

```rust use std::fs::File; use std::io::{BufReader, sink}; use rss::Channel;

let file = File::open("tests/data/rss2sample.xml").unwrap(); let reader = BufReader::new(file); let channel = Channel::read_from(reader).unwrap();

// write to the channel to a writer channel.write_to(sink()).unwrap();

// convert the channel to a string let string = channel.to_string(); ```

Creation

A channel can be created using the Builder functions.

Example

```rust use rss::{ChannelBuilder, ImageBuilder};

let image = ImageBuilder::default() .url("http://jupiterbroadcasting.com/images/LAS-300-Badge.jpg") .title("LAS 300 Logo") .link("http://www.jupiterbroadcasting.com") .finalize();

let channel = ChannelBuilder::default() .title("The Linux Action Show! OGG") .link("http://www.jupiterbroadcasting.com") .description("Ogg Vorbis audio versions of The Linux Action Show!") .image(image) .finalize(); ```

Validation

Validation can be performed using either a Channel or a builder.

The the following checks are performed during validation:

• Ensures that integer properties can be parsed from their string representation into integers
• Ensures that the integer properties are within their valid range according to the RSS 2.0 specification
• Ensures that URL properties can be parsed
• Ensures that string properties where only certain values are allowed fall within those valid values

Example

```rust use rss::Channel;

let input = include_str!("tests/data/rss2sample.xml"); let channel = input.parse::().unwrap(); channel.validate().unwrap(); ```

Example

```rust use rss::ImageBuilder;

let builder = ImageBuilder::default() .url("http://jupiterbroadcasting.com/images/LAS-300-Badge.jpg") .title("LAS 300 Logo") .link("http://www.jupiterbroadcasting.com") .validate() .unwrap(); ```

Extensions

Elements which have non-default namespaces will be considered extensions. Extensions are stored in Channel.extensions and Item.extensions.

For conveninence, Dublin Core and iTunes extensions are extracted to structs and stored in Channel.itunes_ext, Channel.dublin_core_ext, Item.itunes_ext, and Item.dublin_core_ext.

Invalid Feeds

As a best effort to parse invalid feeds rss will default elements declared as "required" by the RSS 2.0 specification to an empty string.

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.