lexlib 2.0.1

library with miscellaneous stuff
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

// Copyright 2023 alexevier <alexevier@proton.me>
// licensed under the zlib license <https://www.zlib.net/zlib_license.html>

//! time.

use crate::c;

pub mod real {
	//! Real time.

	use super::*;

	#[inline(always)]
	pub fn nanos() -> u64 {
		unsafe{c::lexlibTimeNanos()}
	}

	#[inline(always)]
	pub fn micros() -> u64 {
		unsafe{c::lexlibTimeMicros()}
	}

	#[inline(always)]
	pub fn millis() -> u64 {
		unsafe{c::lexlibTimeMillis()}
	}

	#[inline(always)]
	pub fn seconds() -> u64 {
		unsafe{c::lexlibTimeSeconds()}
	}
}

pub mod thread {
	//! cpu time consumed by the thread.

	use super::*;

	#[inline(always)]
	pub fn nanos() -> u64 {
		unsafe{c::lexlibThrdNanos()}
	}

	#[inline(always)]
	pub fn micros() -> u64 {
		unsafe{c::lexlibThrdMicros()}
	}

	#[inline(always)]
	pub fn millis() -> u64 {
		unsafe{c::lexlibThrdMillis()}
	}

	#[inline(always)]
	pub fn seconds() -> u64 {
		unsafe{c::lexlibThrdSeconds()}
	}
}

pub mod process {
	//! cpu time consumed by the process.

	use super::*;

	#[inline(always)]
	pub fn nanos() -> u64 {
		unsafe{c::lexlibProcNanos()}
	}

	#[inline(always)]
	pub fn micros() -> u64 {
		unsafe{c::lexlibProcMicros()}
	}

	#[inline(always)]
	pub fn millis() -> u64 {
		unsafe{c::lexlibProcMillis()}
	}

	#[inline(always)]
	pub fn seconds() -> u64 {
		unsafe{c::lexlibProcSeconds()}
	}
}

/// A simple timer.
///
/// uses real time.<br>
/// millisecond resolution.
#[repr(C)]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Timer {
	time: u64,
	left: u64,
	last: u64,
}

impl Timer {
	/// creates a new Timer.
	///
	/// is started at creation.
	#[inline(always)]
	pub const fn new(ms: u64) -> Self {
		Self {
			time: ms,
			left: ms,
			last: 0,
		}
	}

	/// set the time.
	#[inline(always)]
	pub fn set(&mut self, ms: u64){
		unsafe{c::lexlibTimerSet(self, ms)}
	}

	// add time to a running timer.
	#[inline(always)]
	pub fn add(&mut self, ms: u64){
		unsafe{c::lexlibTimerAdd(self, ms)}
	}

	/// starts/restarts the Timer.
	#[inline(always)]
	pub fn start(&mut self){
		unsafe{c::lexlibTimerStart(self)}
	}

	/// updates the timer.
	#[inline(always)]
	pub fn update(&mut self){
		unsafe{c::lexlibTimerUpdate(self)}
	}

	/// checks if the timer is done.
	///
	/// implicitly calls [`Timer::update`].
	#[inline(always)]
	pub fn done(&mut self) -> bool {
		unsafe{ c::lexlibTimerDone(self) != 0 }
	}

	/// blocks the thread until the timer is done.
	#[inline(always)]
	pub fn until_done(&mut self){
		unsafe{c::lexlibTimerUntilDone(self)}
	}

	/// checks if the Timer has finished.
	///
	/// does not call [`Timer::update`].
	#[inline(always)]
	pub fn finished(&self) -> bool {
		unsafe{ c::lexlibTimerFinished(self) != 0 }
	}

	/// gets the remaining time.
	#[inline(always)]
	pub fn left(&self) -> u64 {
		self.left
	}

	/// gets the initial time.
	#[inline(always)]
	pub fn time(&self) -> u64 {
		self.time
	}
}