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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
//! Module for time related macros

/// Creates a [`Duration`] object following a time pattern.
///
/// **Paterns:**
/// * min: minutes
/// * sec: seconds
/// * nano: nanoseconds
/// * micro: microseconds
/// * milli: milliseconds
///
/// # Examples
/// ```rust
/// use sugars::dur;
///
/// # fn main() {
/// let d = dur!(10 sec);
/// // Sleeps for 10 seconds
/// std::thread::sleep(d);
/// # }
/// ```
///
/// [`Duration`]: ::std::time::Duration
#[macro_export]
macro_rules! dur {
    ($e:literal min) => {{
        let min2sec = $e * 60;
        ::std::time::Duration::from_secs(min2sec)
    }};
    ($i:ident min) => {{
        let min2sec = $i * 60;
        ::std::time::Duration::from_secs(min2sec)
    }};

    ($e:literal sec) => {
        ::std::time::Duration::from_secs($e)
    };
    ($i:ident sec) => {
        ::std::time::Duration::from_secs($i)
    };

    ($e:literal nano) => {
        ::std::time::Duration::from_nanos($e)
    };
    ($i:ident nano) => {
        ::std::time::Duration::from_nanos($i)
    };

    ($e:literal micro) => {
        ::std::time::Duration::from_micros($e)
    };
    ($i:ident micro) => {
        ::std::time::Duration::from_micros($i)
    };

    ($e:literal milli) => {
        ::std::time::Duration::from_millis($e)
    };
    ($i:ident milli) => {
        ::std::time::Duration::from_millis($i)
    };
}

/// Makes a thread sleep a amount following a time pattern.
///
/// **Paterns:**
/// * min: minutes
/// * sec: seconds
/// * nano: nanoseconds
/// * micro: microseconds
/// * milli: milliseconds
///
/// # Examples
/// ```rust
/// use sugars::sleep;
/// # fn main() {
/// // Thread sleeps for 10 seconds
/// sleep!(10 sec);
/// # }
/// ```
#[macro_export]
macro_rules! sleep {
    ($e:literal min) => {{
        let min2sec = $e * 60;
        let dur = ::std::time::Duration::from_secs(min2sec);
        ::std::thread::sleep(dur);
    }};
    ($i:ident min) => {{
        let min2sec = $i * 60;
        let dur = ::std::time::Duration::from_secs(min2sec);
        ::std::thread::sleep(dur);
    }};

    ($e:literal sec) => {{
        let dur = ::std::time::Duration::from_secs($e);
        ::std::thread::sleep(dur);
    }};
    ($i:ident sec) => {{
        let dur = ::std::time::Duration::from_secs($i);
        ::std::thread::sleep(dur);
    }};

    ($e:literal nano) => {{
        let dur = ::std::time::Duration::from_nanos($e);
        ::std::thread::sleep(dur);
    }};
    ($i:ident nano) => {{
        let dur = ::std::time::Duration::from_nanos($i);
        ::std::thread::sleep(dur);
    }};

    ($e:literal micro) => {{
        let dur = ::std::time::Duration::from_micros($e);
        ::std::thread::sleep(dur);
    }};
    ($i:ident micro) => {{
        let dur = ::std::time::Duration::from_micros($i);
        ::std::thread::sleep(dur);
    }};

    ($e:literal milli) => {{
        let dur = ::std::time::Duration::from_millis($e);
        ::std::thread::sleep(dur);
    }};
    ($i:ident milli) => {{
        let dur = ::std::time::Duration::from_millis($i);
        ::std::thread::sleep(dur);
    }};
}

/// Print out the time it took to execute a given expression in seconds.
///
/// Much like Rust standard library `dbg!` macro, but prints the
/// time it takes to run what is passed.
///
/// Like `dbg!` macro, this also supports more than one expression, returning
/// a tuple with the evaluated expressions
///
/// **Note:** requires Rust unstable feature `duration_float`,
/// so it lives on crate feature `nightly`.
///
/// # Example
/// ```rust
/// use sugars::{time, dur};
/// # fn main() {
/// let d = dur!(10 sec);
/// // Sleeps for 10 seconds
/// time!(std::thread::sleep(d)); // Should print 10.000 at least
/// # }
/// ```
///
/// **With multiple expr:**
///
/// Assume `some_comp()` and `another_comp()` as two function that compute
/// something that takes some time.
///
/// ```rust
/// use sugars::time;
/// # use sugars::sleep;
/// # fn some_comp() -> i32{
/// # sleep!(1 sec);
/// # 1 + 1
/// # }
/// # fn another_comp() -> i32 {
/// # sleep!(2 sec);
/// # 1 + 3
/// # }
/// # fn main() {
/// let (a, b) = time!(some_comp(), another_comp());
/// # }
/// ```
#[macro_export]
macro_rules! time {
    ($e:expr) => {{
        let time = ::std::time::Instant::now();
        match $e {
            tmp => {
                eprintln!("{} {:.6} seconds", stringify!($e), time.elapsed().as_secs_f64());
                tmp
            }
        }
    }};
    // Trailing comma with single argument is ignored
    ($e:expr,) => { $crate::time!($e) };
    ($($e:expr),+ $(,)?) => {
        ($($crate::time!($e)),+,)
    };
}

#[cfg(test)]
mod tests {
    use std::time::Duration;

    #[test]
    fn dur_literal_min() {
        let expected = Duration::from_secs(10 * 60);
        let test = dur!(10 min);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_identifier_min() {
        let expected = Duration::from_secs(10 * 60);
        let x = 10;
        let test = dur!(x min);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_literal_sec() {
        let expected = Duration::from_secs(10);
        let test = dur!(10 sec);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_identifier_sec() {
        let expected = Duration::from_secs(10);
        let x = 10;
        let test = dur!(x sec);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_literal_nano() {
        let expected = Duration::from_nanos(10);
        let test = dur!(10 nano);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_identifier_nano() {
        let expected = Duration::from_nanos(10);
        let x = 10;
        let test = dur!(x nano);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_literal_micros() {
        let expected = Duration::from_micros(10);
        let test = dur!(10 micro);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_identifier_micros() {
        let expected = Duration::from_micros(10);
        let x = 10;
        let test = dur!(x micro);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_literal_millis() {
        let expected = Duration::from_millis(10);
        let test = dur!(10 milli);

        assert_eq!(expected, test);
    }

    #[test]
    fn dur_identifier_millis() {
        let expected = Duration::from_millis(10);
        let x = 10;
        let test = dur!(x milli);

        assert_eq!(expected, test);
    }
}