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

mod account;
mod auth;
mod links;
mod listings;
mod messages;
mod users;

use failure::Error;

use net::{Connection, LimitMethod};

/// A reddit object
/// ## Usage:
/// To create a new instance, use `Reddit::new()`
pub struct App {
	pub(crate) conn: Connection,
}

impl App {
	/// Create a new reddit instance
	/// # Arguments
	/// * `appname` - Unique app name
	/// * `appversion` - App version
	/// * `appauthor` - Auther of the app
	/// # Returns
	/// A new reddit object
	pub fn new(appname: &str, appversion: &str, appauthor: &str) -> Result<App, Error> {
		Ok(App { conn: Connection::new(appname, appversion, appauthor)? })
	}

	/// Sets the method to use for ratelimiting.
	/// # Arguments
	/// * `limit` - The method to use for ratelimiting
	pub fn set_ratelimiting(&self, limit: LimitMethod) {
		self.conn.set_limit(limit);
	}
}