Struct zx::Instant

pub struct Instant<T, U = NsUnit>(/* private fields */);

A timestamp from the kernel. Generic over both the timeline and the units it is measured in.

Implementations

impl Instant<MonotonicTimeline>

pub fn get() -> Self

Get the current monotonic time which does not advance during system suspend.

Wraps the zx_clock_get_monotonic syscall.

pub fn after(duration: Duration) -> Self

Compute a deadline for the time in the future that is the given Duration away.

Wraps the zx_deadline_after syscall.

pub fn sleep(self)

Sleep until the given time.

Wraps the zx_nanosleep syscall.

impl Instant<BootTimeline>

pub fn get() -> Self

Get the current boot time which advances during system suspend.

WARNING: this has been added in advance of https://fxrev.dev/1066674, the boot timeline is not yet available in the stable vdso. This currently uses the monotonic clock which is temporarily equivalent to the boot clock until the monotonic clock starts pausing during suspend in the near future. This will be migrated to the boot clock before the monotonic clock begins pausing during suspend.

pub fn after(duration: Duration) -> Self

Compute a deadline for the time in the future that is the given Duration away.

impl<T: Timeline> Instant<T>

pub const INFINITE: Instant<T, NsUnit> = _

pub const INFINITE_PAST: Instant<T, NsUnit> = _

pub const ZERO: Instant<T, NsUnit> = _

pub const fn into_nanos(self) -> i64

Returns the number of nanoseconds since the epoch contained by this Time.

pub const fn from_nanos(nanos: i64) -> Self

Return a strongly-typed Time from a raw number of nanoseconds.

impl Instant<MonotonicTimeline, TicksUnit>

pub fn get() -> Self

Read the number of high-precision timer ticks on the monotonic timeline. These ticks may be processor cycles, high speed timer, profiling timer, etc. They do not advance while the system is suspended.

Wraps the zx_ticks_get syscall.

impl Instant<BootTimeline, TicksUnit>

pub fn get() -> Self

Read the number of high-precision timer ticks on the boot timeline. These ticks may be processor cycles, high speed timer, profiling timer, etc. They advance while the system is suspended.

WARNING: this has been added in advance of https://fxrev.dev/1066674, the boot timeline is not yet available in the stable vdso. This currently uses the monotonic clock which is temporarily equivalent to the boot clock until the monotonic clock starts pausing during suspend in the near future. This will be migrated to the boot clock before the monotonic clock begins pausing during suspend.

impl<T: Timeline> Instant<T, TicksUnit>

pub const fn into_raw(self) -> i64

Return the number of ticks contained by this Ticks.

pub const fn from_raw(raw: i64) -> Self

Return a strongly-typed Ticks from a raw number of system ticks.

pub fn per_second() -> i64

Return the number of high-precision timer ticks in a second.

Wraps the zx_ticks_per_second syscall.

Trait Implementations

impl<T: Timeline, U: TimeUnit> Add<Duration<U>> for Instant<T, U>

type Output = Instant<T, U>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Timeline, U: TimeUnit> Add<Instant<T, U>> for Duration<U>

type Output = Instant<T, U>

The resulting type after applying the + operator.

fn add(self, time: Instant<T, U>) -> Self::Output

Performs the + operation.

impl<T: Timeline, U: TimeUnit> AddAssign<Duration<U>> for Instant<T, U>

fn add_assign(&mut self, dur: Duration<U>)

Performs the += operation.

impl<T, U> Clone for Instant<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U> Debug for Instant<T, U>

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

Formats the value using the given formatter.

impl<T, U> Default for Instant<T, U>

fn default() -> Self

Returns the “default value” for a type.

impl<T, U> Hash for Instant<T, U>

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<T, U> Ord for Instant<T, U>

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<T, U> PartialEq for Instant<T, U>

fn eq(&self, other: &Self) -> 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<T, U> PartialOrd for Instant<T, U>

fn partial_cmp(&self, other: &Self) -> 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<T: Timeline, U: TimeUnit> Sub<Duration<U>> for Instant<T, U>

type Output = Instant<T, U>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Timeline, U: TimeUnit> Sub for Instant<T, U>

type Output = Duration<U>

The resulting type after applying the - operator.

fn sub(self, rhs: Instant<T, U>) -> Self::Output

Performs the - operation.

impl<T: Timeline, U: TimeUnit> SubAssign<Duration<U>> for Instant<T, U>

fn sub_assign(&mut self, dur: Duration<U>)

Performs the -= operation.

impl<T, U> Copy for Instant<T, U>

impl<T, U> Eq for Instant<T, U>