roux-stream
| Crates.io | roux-stream |
| lib.rs | roux-stream |
| version | 0.2.0 |
| source | src |
| created_at | 2021-12-26 13:43:57.186414 |
| updated_at | 2023-05-18 08:21:39.387465 |
| description | A streaming API for the roux Reddit client |
| homepage | https://github.com/torfsen/roux-stream |
| repository | https://github.com/torfsen/roux-stream |
| max_upload_size | |
| id | 503292 |
| size | 77,500 |
Florian Brucker (torfsen)
documentation
README
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.
Contributors
Development
Clone the repository:
git clone https://github.com/torfsen/roux-stream.git
cd roux-stream
Run the tests:
cargo test
Run the example in examples/submissions-and-comments.rs:
cargo run --example submissions-and-comments