1 unstable release
0.2.0 | Dec 18, 2023 |
---|---|
0.1.3 |
|
0.1.2 |
|
0.1.1 |
|
0.1.0 |
|
#1418 in Parser implementations
56 downloads per month
84KB
2K
SLoC
ReadFeed
ReadFeed is a library to process feeds. It provides pull parsers for common feed formats such as RSS and Atom.
Examples
RSS
use readfeed::rss::{self, ChannelElem, Elem, ItemElem, RssElem};
let input = "
<rss>
<channel>
<title>Channel Title</title>
<item>
<title>Item Title 1</title>
<link>https://example.com/1</link>
<description>Item Description 1</description>
</item>
</channel>
</rss>
";
let mut iter = rss::Iter::new(input);
let Some(Elem::Rss(mut rss_iter)) = iter.next() else {
panic!();
};
let Some(RssElem::Channel(mut channel_iter)) = rss_iter.next() else {
panic!();
};
if let Some(ChannelElem::Title(title)) = channel_iter.next() {
assert_eq!("Channel Title", title.content());
} else {
panic!();
}
let Some(ChannelElem::Item(mut item_iter)) = channel_iter.next() else {
panic!();
};
if let Some(ItemElem::Title(title)) = item_iter.next() {
assert_eq!("Item Title 1", title.content());
} else {
panic!();
}
if let Some(ItemElem::Link(link)) = item_iter.next() {
assert_eq!("https://example.com/1", link.content());
} else {
panic!();
}
if let Some(ItemElem::Description(desc)) = item_iter.next() {
assert_eq!("Item Description 1", desc.content());
} else {
panic!();
}
assert_eq!(None, item_iter.next());
assert_eq!(None, channel_iter.next());
assert_eq!(None, rss_iter.next());
assert_eq!(None, iter.next());
Atom
use readfeed::atom::{self, Elem, EntryElem, FeedElem};
let input = r#"
<feed xmlns="http://www.w3.org/2005/Atom">
<title>Lorem ipsum dolor sit amet.</title>
<link href="https://example.com/"/>
<updated>2021-02-24T09:08:10Z</updated>
<id>urn:uuid:ba9192e8-9e34-4c23-8445-94b67ba316ee</id>
<entry>
<title>Lorem ipsum dolor sit.</title>
<link href="http://example.com/2021/02/24/hello"/>
<id>urn:uuid:425ba23c-d283-4580-8a3c-3b67aaa6b373</id>
<updated>2021-02-24T09:08:10Z</updated>
<summary>Lorem ipsum dolor sit amet, consectetur adipiscing.</summary>
</entry>
</feed>
"#;
let mut iter = atom::Iter::new(input);
let Some(Elem::Feed(mut feed_iter)) = iter.next() else {
panic!();
};
if let Some(FeedElem::Title(title)) = feed_iter.next() {
assert_eq!("Lorem ipsum dolor sit amet.", title.content());
} else {
panic!();
}
if let Some(FeedElem::Link(link)) = feed_iter.next() {
assert_eq!(Some("https://example.com/"), link.href().map(|v| v.as_str()));
} else {
panic!();
}
if let Some(FeedElem::Updated(updated)) = feed_iter.next() {
assert_eq!("2021-02-24T09:08:10Z", updated.content());
} else {
panic!();
}
if let Some(FeedElem::Id(id)) = feed_iter.next() {
assert_eq!("urn:uuid:ba9192e8-9e34-4c23-8445-94b67ba316ee", id.content());
} else {
panic!();
}
if let Some(FeedElem::Entry(mut entry_iter)) = feed_iter.next() {
if let Some(EntryElem::Title(title)) = entry_iter.next() {
assert_eq!("Lorem ipsum dolor sit.", title.content());
} else {
panic!();
}
if let Some(EntryElem::Link(link)) = entry_iter.next() {
assert_eq!(Some("http://example.com/2021/02/24/hello"), link.href().map(|v| v.as_str()));
} else {
panic!();
}
if let Some(EntryElem::Id(id)) = entry_iter.next() {
assert_eq!("urn:uuid:425ba23c-d283-4580-8a3c-3b67aaa6b373", id.content());
} else {
panic!();
}
if let Some(EntryElem::Updated(updated)) = entry_iter.next() {
assert_eq!("2021-02-24T09:08:10Z", updated.content());
} else {
panic!();
}
if let Some(EntryElem::Summary(summary)) = entry_iter.next() {
assert_eq!("Lorem ipsum dolor sit amet, consectetur adipiscing.", summary.content());
} else {
panic!();
}
assert_eq!(None, entry_iter.next());
} else {
panic!();
}
assert_eq!(None, feed_iter.next());
assert_eq!(None, iter.next());
Installation
cargo add readfeed
By default, the std
feature is enabled.
Alloc only
If the host environment has an allocator but does not have access to the Rust
std
library:
cargo add --no-default-features --features alloc readfeed
No allocator / core only
If the host environment does not have an allocator:
cargo add --no-default-features readfeed
License
Licensed under either of Apache License, Version 2.0 or MIT License at your option.
Contributions
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~170KB