fidl::handle::fuchsia_handles

Struct Clock

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

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

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

§

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<'_, Handle>

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 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: Instant<MonotonicTimeline>, ) -> 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. Read more
§

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

Set the [Property::NAME] property for this object. Read more
§

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. Read more
§

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

§

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

Converts to this type from the input type.
§

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

§

fn from(handle: Handle) -> 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) -> Handle

Converts the value into its inner handle. Read more
§

fn into_raw(self) -> u32

Converts the handle into it’s raw representation. Read more
§

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle. Read more
§

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. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

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. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
§

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 ==.
1.0.0 · Source§

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. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl<Reference, Output> Eq for Clock<Reference, Output>
where Reference: Eq, Output: Eq,

§

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

Auto Trait Implementations§

§

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

§

impl<Reference, Output> RefUnwindSafe for Clock<Reference, Output>
where Reference: RefUnwindSafe, Output: RefUnwindSafe,

§

impl<Reference, Output> Send for Clock<Reference, Output>
where Reference: Send, Output: Send,

§

impl<Reference, Output> Sync for Clock<Reference, Output>
where Reference: Sync, Output: Sync,

§

impl<Reference, Output> Unpin for Clock<Reference, Output>
where Reference: Unpin, Output: Unpin,

§

impl<Reference, Output> UnwindSafe for Clock<Reference, Output>
where Reference: UnwindSafe, Output: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> EncodableAsHandle for T
where T: HandleBased,

Source§

type Dialect = DefaultFuchsiaResourceDialect

What resource dialect can encode this object as a handle.
Source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

Source§

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. Read more
Source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

Source§

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. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more