benri 0.1.12

Convenient macros wrapping the standard library
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
169
170
171
172
173
174
175
176
177
178
179
180
181

//---------------------------------------------------------------------------------------------------- Use
//use anyhow::{anyhow,bail,ensure};
//use log::{info,error,warn,trace,debug};
//use serde::{Serialize,Deserialize};
//use crate::macros::*;
//use disk::prelude::*;
//use disk::{};
//use std::{};
//use std::sync::{Arc,Mutex,RwLock};

//---------------------------------------------------------------------------------------------------- Thread
#[macro_export]
/// Sleep the current thread for `x` seconds
///
/// ```rust
/// # use benri::time::*;
/// # use benri::thread::*;
/// let now = now!();
///
/// // This sleeps the current thread for 1 second.
/// sleep_secs!(1);
///
/// assert!(secs!(now) >= 1);
/// ```
macro_rules! sleep {
    ($seconds:expr) => {
		::std::thread::sleep(::std::time::Duration::from_secs($seconds))
    }
}
pub use sleep;

#[macro_export]
/// Sleep the current thread for `x` milliseconds
///
/// ```rust
/// # use benri::time::*;
/// # use benri::thread::*;
/// let now = now!();
///
/// // This sleeps the current thread for 1 second.
/// sleep!(1000);
///
/// assert!(secs!(now) >= 1);
/// ```
macro_rules! sleep_millis {
    ($millis:expr) => {
		::std::thread::sleep(::std::time::Duration::from_millis($millis))
    }
}
pub use sleep_millis;

#[macro_export]
/// Sleep the current thread for `x` microseconds
///
/// ```rust
/// # use benri::*;
/// let now = now!();
///
/// // This sleeps the current thread for 1 second.
/// sleep_nanos!(1_000_000);
///
/// assert!(secs!(now) >= 1);
/// ```
macro_rules! sleep_micros {
    ($micros:expr) => {
		::std::thread::sleep(::std::time::Duration::from_micros($micros))
    }
}
pub use sleep_micros;

#[macro_export]
/// Sleep the current thread for `x` nanoseconds
///
/// ```rust
/// # use benri::*;
/// let now = now!();
///
/// // This sleeps the current thread for 1 second.
/// sleep_nanos!(1_000_000_000);
///
/// assert!(secs!(now) >= 1);
/// ```
macro_rules! sleep_nanos {
    ($nanos:expr) => {
		::std::thread::sleep(::std::time::Duration::from_nanos($nanos))
    }
}
pub use sleep_nanos;

#[macro_export]
/// Calls [`std::thread::park`]
macro_rules! park {
    () => {
		::std::thread::park()
    }
}
pub use park;

#[macro_export]
/// Get the total available amount of threads as a [`usize`]
///
/// Calls [`std::thread::available_parallelism`] and converts to a [`usize`]
///
/// If the above function returns [`Err`], `1` will be returned.
macro_rules! threads {
    () => {
		match ::std::thread::available_parallelism() {
			Ok(t)  => usize::from(t),
			Err(e) => {
				#[cfg(feature = "log")]
				::log::error!("std::thread::available_parallelism() failed, returning 1!");
				1_usize
			},
		}
    }
}
pub use threads;

#[macro_export]
/// Get `25%` of the available threads as a `usize`.
///
/// This returns `1` on either `1|2|3` threads, else
/// it multiplies by `0.25` and rounds down.
macro_rules! quarter_threads {
    () => {{
		let threads = $crate::threads!();
		match threads {
			// Special cases (low thread-count).
			1|2 => 1,

			// Around 50%.
			_ => (threads as f64 * 0.5).floor() as usize,
		}
    }}
}
pub use quarter_threads;


#[macro_export]
/// Get `50%` the available threads as a `usize`.
///
/// This returns `1` on either `1|2` threads, else
/// it multiplies by `0.5` and rounds down.
macro_rules! half_threads {
    () => {{
		let threads = $crate::threads!();
		match threads {
			// Special cases (low thread-count).
			1|2 => 1,

			// Around 50%.
			_ => (threads as f64 * 0.5).floor() as usize,
		}
    }}
}
pub use half_threads;

#[macro_export]
/// Gets `80%` of the available threads as a `usize`.
///
/// This returns:
/// - `1` on either `1|2` threads
/// - `2` on `3` threads
/// - `3` on `4` threads
///
/// else, it multiplies by `0.8` and rounds down.
macro_rules! most_threads {
    () => {{
		let threads = $crate::threads!();
		match threads {
			// Special cases (low thread-count).
			1|2 => 1,
			3   => 2,
			4   => 3,

			// Around 80%.
			_ => (threads as f64 * 0.8).floor() as usize,
		}
    }}
}
pub use most_threads;