Struct TimerProperties

pub struct TimerProperties {
    pub id: Option<u64>,
    pub supported_resolutions: Option<Vec<Resolution>>,
    pub max_ticks: Option<u64>,
    pub supports_event: Option<bool>,
    pub supports_wait: Option<bool>,
    /* private fields */
}

Properties for a specific timer abstracted by the driver.

Fields

id: Option<u64>

Unique identifier for this timer.

The id is stable for a given timer, i.e. it does not change across different clients or different connections from the same client.

Required.

supported_resolutions: Option<Vec<Resolution>>

Retrieves the resolutions supported by this timer.

Required.

max_ticks: Option<u64>

Range in ticks.

This is the maximum amount of time that can be set in terms of ticks when a timer is started. The maximum range in actual time (e.g. nanoseconds) depends on the resolution used.

NOTE: The value reported here does not need to be identical to what the hardware actually supports. The driver MAY provide the support for the reported max_ticks that is greater than the largest value of ticks that can be put into the device’s hardware register. The driver supports a greater value of max_ticks by re-programming the hardware counter multiple times with its maximum supported interval, with an interrupt generated after each re-programming. If you want as few re-programmings (and interrupts) to happen as possible, as may be the case when using the hrtimer in a power-aware context, select the coarsest available resolution from [supported_resolutions]. This will ensure the longest possible wall-clock time passes without a re-program.

Required.

supports_event: Option<bool>

If true then the SetEvent method is supported, if false or not present it is not supported.

Optional.

supports_wait: Option<bool>

If true then the StartAndWait and StartAndWait2 methods are supported, if false or not present these methods are not supported.

Optional.

Trait Implementations

impl Clone for TimerProperties

fn clone(&self) -> TimerProperties

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimerProperties

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<TimerProperties, D> for TimerProperties

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for TimerProperties

fn default() -> TimerProperties

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<TimerProperties, D> for &TimerProperties

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for TimerProperties

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

type Owned = TimerProperties

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for TimerProperties

type Borrowed<'a> = &'a TimerProperties

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for TimerProperties

impl StructuralPartialEq for TimerProperties