Struct std::time::SystemTime
pub struct SystemTime(_);
A measurement of the system clock, useful for talking to external entities like the file system or other processes.
Distinct from the Instant
type, this time measurement is not monotonic. This means that you can save a file to the file system, then save another file to the file system, and the second file has a SystemTime
measurement earlier than the first. In other words, an operation that happens after another operation in real time may have an earlier SystemTime
!
Consequently, comparing two SystemTime
instances to learn about the duration between them returns a Result
instead of an infallible Duration
to indicate that this sort of time drift may happen and needs to be handled.
Although a SystemTime
cannot be directly inspected, the UNIX_EPOCH
constant is provided in this module as an anchor in time to learn information about a SystemTime
. By calculating the duration from this fixed point in time, a SystemTime
can be converted to a human-readable time, or perhaps some other string representation.
The size of a SystemTime
struct may vary depending on the target operating system.
Example:
use std::time::{Duration, SystemTime}; use std::thread::sleep; fn main() { let now = SystemTime::now(); // we sleep for 2 seconds sleep(Duration::new(2, 0)); match now.elapsed() { Ok(elapsed) => { // it prints '2' println!("{}", elapsed.as_secs()); } Err(e) => { // an error occurred! println!("Error: {:?}", e); } } }
Underlying System calls
Currently, the following system calls are being used to get the current time using now()
:
Platform | System call |
---|---|
SGX |
insecure_time usercall. More information on timekeeping in SGX
|
UNIX | clock_gettime (Realtime Clock) |
Darwin | gettimeofday |
VXWorks | clock_gettime (Realtime Clock) |
WASI | __wasi_clock_time_get (Realtime Clock) |
Windows | GetSystemTimePreciseAsFileTime / GetSystemTimeAsFileTime |
Disclaimer: These system calls might change over time.
Note: mathematical operations like
add
may panic if the underlying structure cannot represent the new point in time.
Implementations
impl SystemTime
pub const UNIX_EPOCH: SystemTime
An anchor in time which can be used to create new SystemTime
instances or learn about where in time a SystemTime
lies.
This constant is defined to be “1970-01-01 00:00:00 UTC” on all systems with respect to the system clock. Using duration_since
on an existing SystemTime
instance can tell how far away from this point in time a measurement lies, and using UNIX_EPOCH + duration
can be used to create a SystemTime
instance to represent another fixed point in time.
Examples
use std::time::SystemTime; match SystemTime::now().duration_since(SystemTime::UNIX_EPOCH) { Ok(n) => println!("1970-01-01 00:00:00 UTC was {} seconds ago!", n.as_secs()), Err(_) => panic!("SystemTime before UNIX EPOCH!"), }
pub fn now() -> SystemTime
Returns the system time corresponding to “now”.
Examples
use std::time::SystemTime; let sys_time = SystemTime::now();
pub fn duration_since(
&self,
earlier: SystemTime
) -> Result<Duration, SystemTimeError>
Returns the amount of time elapsed from an earlier point in time.
This function may fail because measurements taken earlier are not guaranteed to always be before later measurements (due to anomalies such as the system clock being adjusted either forwards or backwards). Instant
can be used to measure elapsed time without this risk of failure.
If successful, Ok
(
Duration
)
is returned where the duration represents the amount of time elapsed from the specified measurement to this one.
Returns an Err
if earlier
is later than self
, and the error contains how far from self
the time is.
Examples
use std::time::SystemTime; let sys_time = SystemTime::now(); let new_sys_time = SystemTime::now(); let difference = new_sys_time.duration_since(sys_time) .expect("Clock may have gone backwards"); println!("{:?}", difference);
pub fn elapsed(&self) -> Result<Duration, SystemTimeError>
Returns the difference between the clock time when this system time was created, and the current clock time.
This function may fail as the underlying system clock is susceptible to drift and updates (e.g., the system clock could go backwards), so this function might not always succeed. If successful, Ok
(
Duration
)
is returned where the duration represents the amount of time elapsed from this time measurement to the current time.
To measure elapsed time reliably, use Instant
instead.
Returns an Err
if self
is later than the current system time, and the error contains how far from the current system time self
is.
Examples
use std::thread::sleep; use std::time::{Duration, SystemTime}; let sys_time = SystemTime::now(); let one_sec = Duration::from_secs(1); sleep(one_sec); assert!(sys_time.elapsed().unwrap() >= one_sec);
pub fn checked_add(&self, duration: Duration) -> Option<SystemTime>
Returns Some(t)
where t
is the time self + duration
if t
can be represented as SystemTime
(which means it’s inside the bounds of the underlying data structure), None
otherwise.
pub fn checked_sub(&self, duration: Duration) -> Option<SystemTime>
Returns Some(t)
where t
is the time self - duration
if t
can be represented as SystemTime
(which means it’s inside the bounds of the underlying data structure), None
otherwise.
Trait Implementations
impl Add<Duration> for SystemTime
fn add(self, dur: Duration) -> SystemTime
Panics
This function may panic if the resulting point in time cannot be represented by the underlying data structure. See SystemTime::checked_add
for a version without panic.
type Output = SystemTime
The resulting type after applying the +
operator.
impl AddAssign<Duration> for SystemTime
impl Clone for SystemTime
fn clone(&self) -> SystemTime
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for SystemTime
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl Hash for SystemTime
fn hash<__H: Hasher>(&self, state: &mut __H)
impl Ord for SystemTime
fn cmp(&self, other: &SystemTime) -> Ordering
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
Restrict a value to a certain interval. Read more
impl PartialEq<SystemTime> for SystemTime
fn eq(&self, other: &SystemTime) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &SystemTime) -> bool
This method tests for !=
.
impl PartialOrd<SystemTime> for SystemTime
fn partial_cmp(&self, other: &SystemTime) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Sub<Duration> for SystemTime
type Output = SystemTime
The resulting type after applying the -
operator.
fn sub(self, dur: Duration) -> SystemTime
Performs the -
operation. Read more
impl SubAssign<Duration> for SystemTime
impl Copy for SystemTime
impl Eq for SystemTime
impl StructuralEq for SystemTime
impl StructuralPartialEq for SystemTime
Auto Trait Implementations
impl RefUnwindSafe for SystemTime
impl Send for SystemTime
impl Sync for SystemTime
impl Unpin for SystemTime
impl UnwindSafe for SystemTime
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
#41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/time/struct.SystemTime.html