orca 0.7.0

A Reddit API client for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use std::collections::VecDeque;

use data::Comment;
use App;

/// A struct that represents a stream of comments from a subreddit as they are posted. To use it
/// simply create a `for` loop with this is the source. It will automatically retrieve comments
/// as needed. The subreddit can be `all` to create a stream of comments from all of reddit.
pub struct Comments<'a> {
	sub: String,
	cache: VecDeque<Comment>,
	last: Option<String>,
	app: &'a App,
}

impl<'a> Comments<'a> {
	/// Creates a stream of comments from a subreddit
	/// # Arguments
	/// * `app` - A reference to a Reddit `App` instance
	/// * `sub` - The subreddit to load comments from. Can be "all" to stream comments from all
	/// of reddit.
	pub fn new(app: &'a App, sub: &str) -> Comments<'a> {
		let cache: VecDeque<Comment> = VecDeque::new();
		let last = None;

		Comments { sub: sub.to_string(), cache, last, app }
	}

	fn refresh(&mut self, app: &App) {
		let mut resp = app.get_recent_comments(&self.sub, Some(500), self.last.as_ref().map(|s| s.as_str())).expect("Could not get recent comments");

		if let Some(comment) = resp.by_ref().peekable().peek() {
			self.last = Some(comment.name.clone());
		}

		self.cache.append(&mut resp.children);
	}
}

impl<'a> Iterator for Comments<'a> {
	type Item = Comment;

	fn next(&mut self) -> Option<Self::Item> {
		while self.cache.is_empty() {
			self.refresh(self.app);
		}
		self.cache.pop_front()
	}
}

/// Sort type of a subreddit
pub enum Sort {
	/// Hot
	Hot,
	/// New
	New,
	/// Rising
	Rising,
	/// Top within the specified `SortTime`
	Top(SortTime),
	/// Most controversial within the specified `SortTime`
	Controversial(SortTime),
}

impl Sort {
	/// Convert to url parameters
	pub fn param<'a>(self) -> Vec<(&'a str, &'a str)> {
		use self::Sort::*;
		match self {
			Hot => vec![("sort", "hot")],
			New => vec![("sort", "new")],
			Rising => vec![("sort", "rising")],
			Top(sort) => vec![("sort", "top"), sort.param()],
			Controversial(sort) => vec![("sort", "controversial"), sort.param()],
		}
	}
}

/// Time parameter of a subreddit sort
pub enum SortTime {
	/// Hour
	Hour,
	/// Day
	Day,
	/// Week
	Week,
	/// Month
	Month,
	/// Year
	Year,
	/// All time
	All,
}

impl SortTime {
	/// Convert the sort time to a tuple to be used in url parameters
	pub fn param<'a>(self) -> (&'a str, &'a str) {
		use self::SortTime::*;
		(
			"t",
			match self {
				Hour => "hour",
				Day => "day",
				Week => "week",
				Month => "month",
				Year => "year",
				All => "all",
			},
		)
	}
}