Struct zx::Timer

pub struct Timer<T = MonotonicTimeline>(/* private fields */);

An object representing a Zircon timer, such as the one returned by zx_timer_create.

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

Implementations

impl Timer<MonotonicTimeline>

pub fn create() -> Self

Create a timer, an object that can signal when a specified point on the monotonic clock has been reached. Wraps the zx_timer_create syscall.

Panics

If the kernel reports no memory available to create a timer or the process’ job policy denies timer creation.

impl Timer<BootTimeline>

pub fn create() -> Self

Create a timer, an object that can signal when a specified point on the boot clock has been reached. Wraps the zx_timer_create syscall.

If the timer elapses while the system is suspended it will not wake the system.

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.

Panics

If the kernel reports no memory available to create a timer or the process’ job policy denies timer creation.

impl<T: Timeline> Timer<T>

pub fn set( &self, deadline: Instant<T>, slack: Duration<NsUnit>, ) -> Result<(), Status>

Start a one-shot timer that will fire when deadline passes. Wraps the zx_timer_set syscall.

pub fn cancel(&self) -> Result<(), Status>

Cancels a pending timer that was started with set(). Wraps the zx_timer_cancel syscall.

Trait Implementations

impl<T: Timeline> AsHandleRef for Timer<T>

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<T: Debug> Debug for Timer<T>

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

Formats the value using the given formatter.

impl<T: Timeline> From<Handle> for Timer<T>

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl<T: Timeline> From<Timer<T>> for Handle

fn from(x: Timer<T>) -> Handle

Converts to this type from the input type.

impl<T: Timeline> HandleBased for Timer<T>

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<T: Hash> Hash for Timer<T>

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: Ord> Ord for Timer<T>

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

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

fn partial_cmp(&self, other: &Timer<T>) -> 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: Eq> Eq for Timer<T>

impl<T> StructuralPartialEq for Timer<T>