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 Handle, it can be freely interconverted.

Implementations

impl<Output: Timeline> Clock<MonotonicTimeline, Output>

pub fn create( opts: ClockOpts, backstop: Option<Instant<Output>>, ) -> Result<Self, 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: Timeline> Clock<BootTimeline, Output>

pub fn create( opts: ClockOpts, backstop: Option<Instant<Output>>, ) -> Result<Self, 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: Timeline, Output: Timeline> Clock<Reference, Output>

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 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 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: Timeline>( self, ) -> Clock<NewReference, SyntheticTimeline>

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

impl<Reference: Timeline> Clock<Reference, SyntheticTimeline>

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

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: Timeline, Output: Timeline> AsHandleRef for Clock<Reference, Output>

fn as_handle_ref(&self) -> HandleRef<'_>

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

fn raw_handle(&self) -> zx_handle_t

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 signal_handle( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the zx_object_signal syscall.

fn wait_handle( &self, signals: Signals, deadline: MonotonicInstant, ) -> Result<Signals, Status>

Waits on a handle. Wraps the zx_object_wait_one syscall.

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: Debug, Output: Debug> Debug for Clock<Reference, Output>

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

Formats the value using the given formatter.

impl<Reference: Timeline, Output: Timeline> From<Clock<Reference, Output>> for Handle

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

Converts to this type from the input type.

impl<Reference: Timeline, Output: Timeline> From<Handle> for Clock<Reference, Output>

fn from(handle: Handle) -> Self

Converts to this type from the input type.

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

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) -> Handle

Converts the value into its inner handle.

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation.

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle.

fn into_handle_based<H: HandleBased>(self) -> H

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

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

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

fn is_invalid_handle(&self) -> bool

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

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

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: PartialEq, Output: PartialEq> PartialEq for Clock<Reference, Output>

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: PartialOrd, Output: PartialOrd> PartialOrd for Clock<Reference, Output>

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: Eq, Output: Eq> Eq for Clock<Reference, Output>

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