rl-core 1.18.0

Core logic for a token-bucket rate-limiter.
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

#[test]
fn test_serde_serialize() -> Result<(), Box<dyn std::error::Error>> {
	let mut now = std::time::UNIX_EPOCH;
	let cfg = crate::Config::new(std::time::Duration::from_secs(1), 10);
	let mut t = crate::Tracker::default();

	assert_eq!(
		serde_json::to_string(&t)?,
		r#"{}"#);

	now += std::time::Duration::from_secs(20);
	t.acquire_at(&cfg, 4, now)?;

	assert_eq!(
		serde_json::to_string(&t)?,
		r#"{"s":[14,0]}"#);

	assert_eq!(
		serde_json::to_string(&crate::Tracker::<std::time::SystemTime>::overfull(100))?,
		r#"{"o":100}"#);

	assert_eq!(
		serde_json::to_string(&crate::Tracker::<std::time::SystemTime>::unlimited())?,
		r#"{"u":true}"#);

	Ok(())
}

#[test]
fn test_serde_deserialize() -> Result<(), Box<dyn std::error::Error>> {
	assert_eq!(
		serde_json::from_str::<crate::Tracker<std::time::SystemTime>>(r#"{}"#)?,
		crate::Tracker::full());

	assert_eq!(
		serde_json::from_str::<crate::Tracker<std::time::SystemTime>>(r#"{"s":[14,0]}"#)?,
		crate::Tracker::empty_at(std::time::UNIX_EPOCH + std::time::Duration::from_secs(14)));

	assert_eq!(
		serde_json::from_str::<crate::Tracker<std::time::SystemTime>>(r#"{"o":100}"#)?,
		crate::Tracker::overfull(100));

	Ok(())
}

#[test]
fn test_serde_deserialize_priority() -> Result<(), Box<dyn std::error::Error>> {
	// No one should depend on this behaviour but we have tests to ensure that any change to this is intentional.

	assert_eq!(
		serde_json::from_str::<crate::Tracker<std::time::SystemTime>>(r#"{"s": [4, 400000000], "o": 100, "u": true}"#)?,
		crate::Tracker::empty_at(std::time::UNIX_EPOCH + std::time::Duration::from_millis(4_400)));

	assert_eq!(
		serde_json::from_str::<crate::Tracker<std::time::SystemTime>>(r#"{"o": 100, "u": false}"#)?,
		crate::Tracker::overfull(100));

	assert_eq!(
		serde_json::from_str::<crate::Tracker<std::time::SystemTime>>(r#"{"o": 100, "u": true}"#)?,
		crate::Tracker::unlimited());

	Ok(())
}

#[test]
fn test_serde_old() -> Result<(), Box<dyn std::error::Error>> {
	assert_eq!(
		serde_json::from_str::<crate::Tracker<std::time::SystemTime>>(r#"{"l":null}"#)?,
		crate::Tracker::full());

	Ok(())
}