Struct 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() -> Instant<MonotonicTimeline>

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

Wraps the zx_clock_get_monotonic syscall.

pub fn after( duration: Duration<MonotonicTimeline>, ) -> Instant<MonotonicTimeline>

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() -> Instant<BootTimeline>

Get the current boot time which advances during system suspend.

pub fn after(duration: Duration<BootTimeline>) -> Instant<BootTimeline>

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

impl<T, U> Instant<T, U>

where T: Timeline, U: TimeUnit,

pub const ZERO: Instant<T, U>

impl<T> Instant<T>

where T: Timeline,

pub const INFINITE: Instant<T>

pub const INFINITE_PAST: Instant<T>

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) -> Instant<T>

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

impl Instant<MonotonicTimeline, TicksUnit>

pub fn get() -> Instant<MonotonicTimeline, TicksUnit>

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() -> Instant<BootTimeline, TicksUnit>

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.

impl<T> Instant<T, TicksUnit>

where T: Timeline,

pub const fn into_raw(self) -> i64

Return the number of ticks contained by this Ticks.

pub const fn from_raw(raw: i64) -> Instant<T, TicksUnit>

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

where T: Timeline, U: TimeUnit,

type Output = Instant<T, U>

The resulting type after applying the + operator.

fn add( self, dur: Duration<T, U>, ) -> <Instant<T, U> as Add<Duration<T, U>>>::Output

Performs the + operation.

impl<T, U> Add<Instant<T, U>> for Duration<T, U>

where T: Timeline, U: TimeUnit,

type Output = Instant<T, U>

The resulting type after applying the + operator.

fn add( self, time: Instant<T, U>, ) -> <Duration<T, U> as Add<Instant<T, U>>>::Output

Performs the + operation.

impl<T, U> AddAssign<Duration<T, U>> for Instant<T, U>

where T: Timeline, U: TimeUnit,

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

Performs the += operation.

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

where T: Clone, U: Clone,

fn clone(&self) -> Instant<T, U>

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<(), Error>

Formats the value using the given formatter.

impl<T, D> Decode<Instant<T>, D> for Instant<T>

where T: Timeline + 'static, D: ResourceDialect,

fn new_empty() -> Instant<T>

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl<T, D> Decode<Instant<T, TicksUnit>, D> for Instant<T, TicksUnit>

where T: Timeline + 'static, D: ResourceDialect,

fn new_empty() -> Instant<T, TicksUnit>

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

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

where T: Default, U: Default,

fn default() -> Instant<T, U>

Returns the “default value” for a type.

impl<T, D> Encode<Instant<T>, D> for Instant<T>

where T: Timeline + Copy + 'static, D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl<T, D> Encode<Instant<T, TicksUnit>, D> for Instant<T, TicksUnit>

where T: Timeline + 'static, D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl From<BootInstant> for Instant<BootTimeline>

fn from(t: BootInstant) -> Instant<BootTimeline>

Converts to this type from the input type.

impl From<MonotonicInstant> for Instant<MonotonicTimeline>

fn from(t: MonotonicInstant) -> Instant<MonotonicTimeline>

Converts to this type from the input type.

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

where i64: FromBytes, PhantomData<(T, U)>: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &Self with a DST length equal to count.

fn ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the prefix of the given source as a DST &Self with length equal to count.

fn ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the suffix of the given source as a DST &Self with length equal to count.

fn mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &mut Self with a DST length equal to count.

fn mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the prefix of the given source as a &mut Self with DST length equal to count.

fn mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the suffix of the given source as a &mut Self with DST length equal to count.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

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

where i64: FromZeros, PhantomData<(T, U)>: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

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

where T: Hash, U: Hash,

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

where __H: Hasher,

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

where i64: IntoBytes, PhantomData<(T, U)>: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

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

where T: Ord, U: Ord,

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

where T: PartialEq, U: PartialEq,

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

where T: PartialOrd, U: PartialOrd,

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

where T: Timeline, U: TimeUnit,

type Output = Instant<T, U>

The resulting type after applying the - operator.

fn sub( self, dur: Duration<T, U>, ) -> <Instant<T, U> as Sub<Duration<T, U>>>::Output

Performs the - operation.

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

where T: Timeline, U: TimeUnit,

type Output = Duration<T, U>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, U> SubAssign<Duration<T, U>> for Instant<T, U>

where T: Timeline, U: TimeUnit,

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

Performs the -= operation.

impl<T> TakeFrom<WireI64> for Instant<T>

where T: Timeline,

fn take_from(from: &WireI64) -> Instant<T>

Converts from the given T, taking any resources that can’t be cloned.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly during conversion instead of calling take_from.

impl<T> TakeFrom<WireI64> for Instant<T, TicksUnit>

where T: Timeline,

fn take_from(from: &WireI64) -> Instant<T, TicksUnit>

Converts from the given T, taking any resources that can’t be cloned.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly during conversion instead of calling take_from.

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

where i64: TryFromBytes, PhantomData<(T, U)>: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the given source as a &Self with a DST length equal to count.

fn try_ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the prefix of the given source as a &Self with a DST length equal to count.

fn try_ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the suffix of the given source as a &Self with a DST length equal to count.

fn try_mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self with a DST length equal to count.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

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

where T: Timeline + 'static, U: 'static,

type Owned = Instant<T, U>

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

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

where T: Timeline + Copy + 'static, U: Copy + 'static,

type Borrowed<'a> = Instant<T, U>

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<Instant<T, U> as TypeMarker>::Owned, ) -> <Instant<T, U> as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl WakeupTime for Instant<BootTimeline>

fn into_timer(self) -> Timer

Create a timer based on this time.

impl WakeupTime for Instant<MonotonicTimeline>

fn into_timer(self) -> Timer

Create a timer based on this time.

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

where T: Copy, U: Copy,

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

where T: Eq, U: Eq,

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

where i64: Immutable, PhantomData<(T, U)>: Immutable,

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