Struct cap_primitives::time::SystemTime

pub struct SystemTime { /* private fields */ }

A measurement of the system clock, useful for talking to external entities like the file system or other processes.

This corresponds to std::time::SystemTime.

This SystemTime has no now, elapsed methods. To obtain the current time or measure the duration to the current time, first obtain a SystemClock, and then call SystemClock::now or SystemClock::elapsed instead. The UNIX_EPOCH constant is at SystemClock::UNIX_EPOCH.

Similar to the filetime crate, when RUSTFLAGS=--cfg emulate_second_only_system is set, SystemTime will round times from the operating system down to the second. This emulates the behavior of some file systems, mostly HFS, allowing debugging on other hardware.

Implementations

impl SystemTime

pub fn from_std(std: SystemTime) -> Self

Constructs a new instance of Self from the given std::time::SystemTime.

Examples found in repository

src/time/system_clock.rs (line 38)

    pub fn now(&self) -> SystemTime {
        SystemTime::from_std(time::SystemTime::now())
    }

src/fs/system_time_spec.rs (line 24)

    pub fn from_std(std: fs_set_times::SystemTimeSpec) -> Self {
        match std {
            fs_set_times::SystemTimeSpec::SymbolicNow => Self::SymbolicNow,
            fs_set_times::SystemTimeSpec::Absolute(time) => {
                Self::Absolute(SystemTime::from_std(time))
            }
        }
    }

pub const fn into_std(self) -> SystemTime

Constructs a new instance of std::time::SystemTime from the given Self.

Examples found in repository

src/fs/system_time_spec.rs (line 35)

    pub const fn into_std(self) -> fs_set_times::SystemTimeSpec {
        match self {
            Self::SymbolicNow => fs_set_times::SystemTimeSpec::SymbolicNow,
            Self::Absolute(time) => fs_set_times::SystemTimeSpec::Absolute(time.into_std()),
        }
    }

pub fn duration_since(&self, earlier: Self) -> Result<Duration, SystemTimeError>

Returns the amount of time elapsed from another instant to this one.

This corresponds to std::time::SystemTime::duration_since.

pub fn checked_add(&self, duration: Duration) -> Option<Self>

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.

This corresponds to std::time::SystemTime::checked_add.

Examples found in repository

src/time/system_time.rs (line 96)

    fn add(self, dur: Duration) -> Self {
        self.checked_add(dur)
            .expect("overflow when adding duration to instant")
    }

pub fn checked_sub(&self, duration: Duration) -> Option<Self>

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.

This corresponds to std::time::SystemTime::checked_sub.

Examples found in repository

src/time/system_time.rs (line 113)

    fn sub(self, dur: Duration) -> Self {
        self.checked_sub(dur)
            .expect("overflow when subtracting duration from instant")
    }

Trait Implementations

impl Add<Duration> for SystemTime

fn add(self, dur: Duration) -> Self

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

fn add_assign(&mut self, other: Duration)

Performs the += operation.

impl Clone for SystemTime

fn clone(&self) -> SystemTime

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SystemTime

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<SystemTime> for SystemTimeSpec

fn from(time: SystemTime) -> Self

Converts to this type from the input type.

impl Hash for SystemTime

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SystemTime

fn cmp(&self, other: &SystemTime) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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 ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Duration> for SystemTime

type Output = SystemTime

The resulting type after applying the - operator.

fn sub(self, dur: Duration) -> Self

Performs the - operation.

impl SubAssign<Duration> for SystemTime

fn sub_assign(&mut self, other: Duration)

Performs the -= operation.

impl Copy for SystemTime

impl Eq for SystemTime

impl StructuralEq for SystemTime

impl StructuralPartialEq for SystemTime