feed-rs

Crates.iofeed-rs
lib.rsfeed-rs
version2.1.1
sourcesrc
created_at2017-06-15 06:45:16.71733
updated_at2024-10-06 01:49:40.31263
descriptionAn RSS (2.0, 1.0 and 0x), Atom and JSON Feed parser
homepagehttps://github.com/feed-rs/feed-rs
repositoryhttps://github.com/feed-rs/feed-rs.git
max_upload_size
id19044
size479,048
Mark Pritchard (markpritchard)

documentation

README

feed-rs

Build Status Crates.io Status

Library for parsing various forms of feeds such as Atom, RSS and JSON Feed. It also supports extensions such as iTunes, Dublin Core and Media RSS and serialisation/deserialisation via serde.

Documentation

Usage

Add the dependency to your Cargo.toml.

[dependencies]
feed-rs = "2.1.1"

Reading

A feed can be parsed from any object that implements the Read trait.

use feed_rs::parser;
let xml = r#"
<feed>
   <title type="text">sample feed</title>
   <updated>2005-07-31T12:29:29Z</updated>
   <id>feed1</id>
   <entry>
       <title>sample entry</title>
       <id>entry1</id>
   </entry>
</feed>
"#;
let feed = parser::parse(xml.as_bytes()).unwrap();

The parser will automatically detect XML vs. JSON so parsing JSON Feed content works the same way.

use feed_rs::parser;
let json = r#"
{
  "version": "https://jsonfeed.org/version/1",
  "title": "JSON Feed",
  "description": "JSON Feed is a pragmatic syndication format for blogs, microblogs, and other time-based content.",
  "home_page_url": "https://jsonfeed.org/",
  "feed_url": "https://jsonfeed.org/feed.json",
  "author": {
    "name": "Brent Simmons and Manton Reece",
    "url": "https://jsonfeed.org/"
  },
  "items": [
    {
      "title": "Announcing JSON Feed",
      "date_published": "2017-05-17T08:02:12-07:00",
      "id": "https://jsonfeed.org/2017/05/17/announcing_json_feed",
      "url": "https://jsonfeed.org/2017/05/17/announcing_json_feed",
      "content_html": "<p>We — Manton Reece and Brent Simmons — have noticed that JSON...</p>"
    }
  ]
}"#;
let feed = parser::parse(json.as_bytes()).unwrap();

License

MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Contribution

Any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.

Original author

This crate was originally created by Hiroki Kumamoto. I would like to pay my respects to Kumamoto-san, and say thank you for allowing me to take over the crate and its ongoing maintenance. ありがとう ございます!

Commit count: 426

cargo fmt