dark0dave / roux-stream

Streaming API for the Rust Reddit Client roux

roux-stream

A streaming API for the Rust Reddit client roux.

Reddit's API does not provide "firehose"-style streaming of new posts and comments. Instead, the endpoints for retrieving the latest posts and comments have to be polled regularly. This crate automates that task and provides streams for a subreddit's posts (submissions) and comments.

Documentation

The documentation is available on docs.rs and contains examples for streaming submissions and streaming comments.

An example for streaming both submissions and comments at the same time can be found in the file examples/submissions-and-comments.rs.

License

Distributed under the MIT license. See the file LICENSE for details.

Changelog

See the file CHANGELOG.md.

Development

Clone the repository:

git clone https://github.com/torfsen/roux-stream.git
cd roux-stream

Run the tests:

cargo test