ira 0.3.0

A general-purpose, code-first game engine.
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

use std::time::{Duration, Instant};

/// A simple rate limiter.
///
/// This rate limiter is useful for limiting the rate at
/// which an action can be performed.
///
/// Note that, regardless of `period`, the first action
/// will always be allowed.
///
/// # Examples
///
/// ```rust
/// let mut ratelimit = Ratelimit::new(Duration::from_secs(1));
/// let mut actions = 0;
///
/// for _ in 0..3 {
///   if ratelimit.check() {
///     actions += 1;
///   }
///
///   sleep(Duration::from_millis(600));
/// }
///
/// assert_eq!(actions, 2);
/// ```
#[derive(Debug)]
pub struct Ratelimit {
	last: Option<Instant>,
	period: Duration,
}

impl Ratelimit {
	/// Creates a new rate limiter with the given period.
	#[must_use]
	pub fn new(period: Duration) -> Self {
		Self { last: None, period }
	}

	/// Checks if the rate limiter allows an action to be performed.
	///
	/// If the rate limiter allows the action, the rate limiter
	/// will be updated and the function will return `true`.
	///
	/// If the rate limiter does not allow the action, the function
	/// will return `false`.
	pub fn check(&mut self) -> bool {
		if let Some(last) = self.last {
			if last.elapsed() < self.period {
				return false;
			}
		}

		self.last = Some(Instant::now());
		true
	}
}