Struct Time 

pub struct Time(/* private fields */);

A point in time.

Low overhead time representation. Internally represented as milliseconds.

Implementations

impl Time

pub const MAX: Self

pub const EPOCH: Self

pub const fn millis(millis: i64) -> Self

pub const fn seconds(seconds: i64) -> Self

pub const fn minutes(minutes: i64) -> Self

pub const fn hours(hours: i64) -> Self

pub fn now() -> Time

Returns the current time instance based on SystemTime

Don’t use this method to compare if the current time has passed a certain deadline.

pub const fn as_seconds(&self) -> i64

Returns the number of whole seconds in the time.

Examples

assert_eq!(Time::minutes(1).as_seconds(), 60);

pub const fn as_millis(&self) -> i64

pub const fn as_subsecond_nanos(&self) -> i32

Returns the number of subsecond millis converted to nanos.

Examples

assert_eq!(Time::millis(12345).as_subsecond_nanos(), 345_000_000);

pub const fn round_down(&self, step_size: Duration) -> Time

Rounds time down to a step size

Examples

assert_eq!(
    Time::minutes(7).round_down(Duration::minutes(5)),
    Time::minutes(5)
);
assert_eq!(
    Time::minutes(5).round_down(Duration::minutes(5)),
    Time::minutes(5)
);

pub const fn round_up(&self, step_size: Duration) -> Time

Rounds time up to a step size

Examples

assert_eq!(
    Time::minutes(7).round_up(Duration::minutes(5)),
    Time::minutes(10)
);
assert_eq!(
    Time::minutes(5).round_up(Duration::minutes(5)),
    Time::minutes(5)
);

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

Checked time duration substraction. Computes self - rhs, returning None if overflow occurred.

Examples

assert_eq!(
    Time::minutes(8).checked_sub(Duration::minutes(5)),
    Some(Time::minutes(3))
);
assert_eq!(Time::minutes(3).checked_sub(Duration::minutes(5)), None);
assert_eq!(
    Time::minutes(2).checked_sub(Duration::minutes(2)),
    Some(Time::EPOCH)
);

pub const fn since_epoch(&self) -> Duration

Methods from Deref<Target = i64>

pub const MIN: i64

pub const MAX: i64

pub const BITS: u32 = u64::BITS

Trait Implementations

impl Add<Duration> for Time

type Output = Time

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation.

impl AddAssign<Duration> for Time

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl Clone for Time

fn clone(&self) -> Time

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl Default for Time

fn default() -> Time

Returns the “default value” for a type.

impl Deref for Time

type Target = i64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<SystemTime> for Time

fn from(input: SystemTime) -> Self

Converts to this type from the input type.

impl From<Time> for i64

fn from(time: Time) -> Self

Converts to this type from the input type.

impl From<i64> for Time

fn from(value: i64) -> Self

Converts to this type from the input type.

impl Hash for Time

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 Time

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Time

fn eq(&self, other: &Time) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Time

fn partial_cmp(&self, other: &Time) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Rem<Duration> for Time

type Output = Duration

The resulting type after applying the % operator.

fn rem(self, rhs: Duration) -> Self::Output

Performs the % operation.

impl Sub<Duration> for Time

type Output = Time

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Self::Output

Performs the - operation.

impl Sub for Time

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Time) -> Self::Output

Performs the - operation.

impl SubAssign<Duration> for Time

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl TryFrom<Duration> for Time

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(duration: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Time> for SystemTime

type Error = TimeIsNegativeError

The type returned in the event of a conversion error.

fn try_from(input: Time) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Time

impl Eq for Time

impl StructuralPartialEq for Time