Struct Clock 

pub struct Clock<Reference = MonotonicTimeline, Output = SyntheticTimeline>(/* private fields */);

An object representing a kernel clock, used to track the progress of time. A clock is a one-dimensional affine transformation of the clock monotonic reference timeline which may be atomically adjusted by a maintainer and observed by clients.

As essentially a subtype of NullableHandle, it can be freely interconverted.

Implementations

impl<Output> Clock<MonotonicTimeline, Output>

where Output: Timeline,

pub fn create( opts: ClockOpts, backstop: Option<Instant<Output>>, ) -> Result<Clock<MonotonicTimeline, Output>, Status>

Create a new clock object with the provided arguments, with the monotonic clock as the reference timeline. Wraps the zx_clock_create syscall.

impl<Output> Clock<BootTimeline, Output>

where Output: Timeline,

pub fn create( opts: ClockOpts, backstop: Option<Instant<Output>>, ) -> Result<Clock<BootTimeline, Output>, Status>

Create a new clock object with the provided arguments, with the boot clock as the reference timeline. Wraps the zx_clock_create syscall.

impl<Reference, Output> Clock<Reference, Output>

where Reference: Timeline, Output: Timeline,

pub fn read(&self) -> Result<Instant<Output>, Status>

Perform a basic read of this clock. Wraps the zx_clock_read syscall. Requires ZX_RIGHT_READ and that the clock has had an initial time established.

pub unsafe fn read_mapped(clock_addr: usize) -> Result<Instant<Output>, Status>

Perform a basic read of a mapped clock. Wraps the [zx_clock_read_mapped] syscall.

Safety

|zx_clock_get_details_mapped| must only be called using a |clock_addr| which is the address of a clock’s state currently mapped into the caller’s address space using |zx_vmar_map_clock|. Attempting to get_details from any other address, or from a clock mapping which has been unmapped (completely or partially) will result in undefined behavior.

pub fn get_details(&self) -> Result<ClockDetails<Reference, Output>, Status>

Get low level details of this clock’s current status. Wraps the zx_clock_get_details syscall. Requires ZX_RIGHT_READ.

pub unsafe fn get_details_mapped( clock_addr: usize, ) -> Result<ClockDetails<Reference, Output>, Status>

Get low level details of a mapped clock’s current status. Wraps the zx_clock_get_details_mapped syscall.

Safety

|zx_clock_get_details_mapped| must only be called using a |clock_addr| which is the address of a clock’s state currently mapped into the caller’s address space using |zx_vmar_map_clock|. Attempting to get_details from any other address, or from a clock mapping which has been unmapped (completely or partially) will result in undefined behavior.

pub fn get_mapped_size( clock: &Clock<Reference, Output>, ) -> Result<usize, Status>

pub fn update( &self, update: impl Into<ClockUpdate<Reference, Output>>, ) -> Result<(), Status>

Make adjustments to this clock. Wraps the zx_clock_update syscall. Requires ZX_RIGHT_WRITE.

pub fn downcast<NewReference>(self) -> Clock<NewReference>

where NewReference: Timeline,

Convert this clock to one on a generic synthetic timeline, erasing any user-defined timeline.

pub fn into_raw(self) -> u32

Return the raw handle’s integer value without closing it when self is dropped.

pub fn duplicate( &self, rights: Rights, ) -> Result<Clock<Reference, Output>, Status>

Wraps the zx_handle_duplicate syscall.

pub fn replace(self, rights: Rights) -> Result<Clock<Reference, Output>, Status>

Wraps the zx_handle_replace syscall.

pub fn signal( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Wraps the zx_object_signal syscall.

pub fn wait_one( &self, signals: Signals, deadline: Instant<MonotonicTimeline>, ) -> WaitResult

Wraps the zx_object_wait_one syscall.

impl<Reference> Clock<Reference>

where Reference: Timeline,

pub fn cast<NewReference, UserTimeline>( self, ) -> Clock<NewReference, UserTimeline>

where NewReference: Timeline, UserTimeline: Timeline,

Cast a “base” clock to one with a user-defined timeline that will carry the timeline for all transformations and reads.

Trait Implementations

impl<Reference, Output> AsHandleRef for Clock<Reference, Output>

where Reference: Timeline, Output: Timeline,

fn as_handle_ref(&self) -> Unowned<'_, NullableHandle>

Get a reference to the handle. One important use of such a reference is for object_wait_many.

fn raw_handle(&self) -> u32

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).

fn wait_async_handle( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>

Causes packet delivery on the given port when the object changes state and matches signals. zx_object_wait_async syscall.

fn get_name(&self) -> Result<Name, Status>

Get the Property::NAME property for this object.

fn set_name(&self, name: &Name) -> Result<(), Status>

Set the Property::NAME property for this object.

fn basic_info(&self) -> Result<HandleBasicInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

fn count_info(&self) -> Result<HandleCountInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

fn get_koid(&self) -> Result<Koid, Status>

Returns the koid (kernel object ID) for this handle.

impl<Reference, Output> Debug for Clock<Reference, Output>

where Reference: Debug, Output: Debug,

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

Formats the value using the given formatter.

impl<Reference, Output> From<Clock<Reference, Output>> for NullableHandle

where Reference: Timeline, Output: Timeline,

fn from(x: Clock<Reference, Output>) -> NullableHandle

Converts to this type from the input type.

impl<Reference, Output> From<NullableHandle> for Clock<Reference, Output>

where Reference: Timeline, Output: Timeline,

fn from(handle: NullableHandle) -> Clock<Reference, Output>

Converts to this type from the input type.

impl<Reference, Output> HandleBased for Clock<Reference, Output>

where Reference: Timeline, Output: Timeline,

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.

fn replace_handle(self, rights: Rights) -> Result<Self, Status>

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the zx_handle_replace syscall.

fn into_handle(self) -> NullableHandle

Converts the value into its inner handle.

fn into_raw(self) -> u32

Converts the handle into it’s raw representation.

fn from_handle(handle: NullableHandle) -> Self

Creates an instance of this type from a handle.

fn into_handle_based<H>(self) -> H

where H: HandleBased,

Creates an instance of another handle-based type from this value’s inner handle.

fn from_handle_based<H>(h: H) -> Self

where H: HandleBased,

Creates an instance of this type from the inner handle of another handle-based type.

fn is_invalid_handle(&self) -> bool

impl<Reference, Output> Hash for Clock<Reference, Output>

where Reference: Hash, Output: 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<Reference, Output> Ord for Clock<Reference, Output>

where Reference: Ord, Output: Ord,

fn cmp(&self, other: &Clock<Reference, Output>) -> 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<Reference, Output> PartialEq for Clock<Reference, Output>

where Reference: PartialEq, Output: PartialEq,

fn eq(&self, other: &Clock<Reference, Output>) -> 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<Reference, Output> PartialOrd for Clock<Reference, Output>

where Reference: PartialOrd, Output: PartialOrd,

fn partial_cmp(&self, other: &Clock<Reference, Output>) -> 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<Reference, Output> Eq for Clock<Reference, Output>

where Reference: Eq, Output: Eq,

impl<Reference, Output> StructuralPartialEq for Clock<Reference, Output>