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
Usage
Add the dependency to your Cargo.toml
.
[]
= "0.6"
The package includes a single crate named rss
.
extern crate rss;
Reading
A channel can be read from any object that implements the BufRead
trait.
let reader: BufRead = ...;
let channel = read_from.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.
let channel: Channel = ...;
let writer: Write = ...;
// write the channel to a writer
channel.write_to.unwrap;
// convert the channel to a string
let string = channel.to_string;
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.