Struct Timer 

pub struct Timer(/* 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

pub fn create(clock_id: ClockId) -> Result<Timer, Status>

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

pub fn set(&self, deadline: Time, slack: Duration) -> 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 start(). Wraps the zx_timer_cancel syscall.

Trait Implementations

impl AsHandleRef for Timer

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: Time, ) -> 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.

impl Debug for Timer

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

Formats the value using the given formatter.

impl From<Handle> for Timer

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl From<Timer> for Handle

fn from(x: Timer) -> Handle

Converts to this type from the input type.

impl HandleBased for Timer

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.

impl PartialEq for Timer

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

impl StructuralPartialEq for Timer