helpers4 0.0.6

General-purpose Rust helpers, one crate, one feature per module (string, array, ...)
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

// This file is part of helpers4.
// Copyright (C) 2025 baxyz
// SPDX-License-Identifier: LGPL-3.0-or-later

use std::time::SystemTime;

use super::_epoch::since_epoch;
use super::error::ClockError;

/// The current time as whole seconds since the Unix epoch.
///
/// # Errors
///
/// [`ClockError`] when the system clock is set before 1970. Do not turn that into `0`: a token
/// expiry checked against `0` would look valid forever.
///
/// # Examples
///
/// ```
/// use helpers4::time::unix_now;
///
/// let now = unix_now()?;
/// assert!(now > 1_700_000_000); // after November 2023
/// # Ok::<(), helpers4::time::ClockError>(())
/// ```
pub fn unix_now() -> Result<u64, ClockError> {
    since_epoch(SystemTime::now()).map(|elapsed| elapsed.as_secs())
}

#[cfg(test)]
#[path = "unix_now.test.rs"]
mod tests;