keysmith 0.4.0

Create keys, uuid's, timestamps, and more.
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

//! Gets a timestamp.
//! This is in seconds or milliseconds since the first second of 2022,
//! a custom epoch, or from plain UTC.

use chrono::{DateTime, Utc};

const DEFAULT_EPOCH: &str = "Sat, 1 Jan 2022 00:00:00 +0000";
const UTC_EPOCH: &str = "Thu, 1 Jan 1970 00:00:00 +0000";

/// Generates a timestamp from the input epoch
///
/// Format = "Sat, 1 Jan 2022 00:00:00 +0000"
fn gen_timestamp(epoch_str: &str) -> i64 {
	let epoch = DateTime::parse_from_rfc2822(epoch_str)
		.expect("ERROR: Could not get timestamp epoch.");

	let now = Utc::now();
	now.timestamp() - epoch.timestamp()
}

fn gen_timestamp_ms(epoch_str: &str) -> i64 {
	let epoch = DateTime::parse_from_rfc2822(epoch_str)
		.expect("ERROR: Could not get timestamp epoch.");
	let now = Utc::now();

	now.timestamp_millis() - epoch.timestamp_millis()
}

// Public API

/// Gets a timestamp from the first second of 2022 as a String.
///
/// ex: 50546851
pub fn timestamp() -> String {
	timestamp_i64().to_string()
}

/// Gets a timestamp from the the first second of 2022 as an i64.
///
/// ex: 50546851
pub fn timestamp_i64() -> i64 {
	gen_timestamp(DEFAULT_EPOCH)
}

/// Gets a timestamp since the first second of 1970 as a String.
///
/// ex: 1691542051
pub fn timestamp_utc() -> String {
	timestamp_utc_i64().to_string()
}

/// Gets a timestamp since the first second of 1970 as an i64.
///
/// ex: 1691542051
pub fn timestamp_utc_i64() -> i64 {
	gen_timestamp(UTC_EPOCH)
}

/// Gets a timestamp from the first second of 2022 as a String
/// using milliseconds.
///
/// ex: 50546851978
pub fn timestamp_ms() -> String {
	timestamp_ms_i64().to_string()
}

/// Gets a timestamp from the first second of 2022 as an i64
/// using milliseconds.
///
/// ex: 50546851978
pub fn timestamp_ms_i64() -> i64 {
	gen_timestamp_ms(DEFAULT_EPOCH)
}

/// Gets a timestamp from a custom epoch as a String.
///
/// Format = "Sat, 1 Jan 2022 00:00:00 +0000".
///
/// ex: 176777251
pub fn timestamp_custom(epoch: &str) -> String {
	timestamp_custom_i64(epoch).to_string()
}

/// Gets a timestamp from a custom epoch as an i64.
///
/// Format = "Sat, 1 Jan 2022 00:00:00 +0000".
///
/// ex: 176777251
pub fn timestamp_custom_i64(epoch: &str) -> i64 {
	gen_timestamp(epoch)
}

/// Gets a timestamp from a custom epoch as a String
/// using milliseconds.
///
/// Format = "Sat, 1 Jan 2022 00:00:00 +0000".
///
/// ex: 176777251981
pub fn timestamp_ms_custom(epoch: &str) -> String {
	timestamp_ms_custom_i64(epoch).to_string()
}

/// Gets a timestamp from a custom epoch as an i64
/// using milliseconds.
///
/// Format = "Sat, 1 Jan 2022 00:00:00 +0000".
///
/// ex: 176777251981
pub fn timestamp_ms_custom_i64(epoch: &str) -> i64 {
	gen_timestamp_ms(epoch)
}

// Tests

#[cfg(test)]
mod tests {
	use super::*;

	/// Ensure gen_timestamp() returns the correct timestamp:
	#[test]
	fn test_gen_timestamp() {
		// Define an example epoch string

		// Parse the epoch string into a DateTime object
		let epoch = DateTime::parse_from_rfc2822(DEFAULT_EPOCH)
			.expect("Failed to parse epoch string");

		// Call the function with the example epoch string
		let result = gen_timestamp(DEFAULT_EPOCH);

		// Calculate the expected result
		let now = Utc::now();
		let expected = now.timestamp() - epoch.timestamp();

		// Compare the actual result with the expected result
		assert_eq!(result, expected);
	}
}