Struct TimeBaseId 

#[repr(transparent)]
pub struct TimeBaseId(pub u32);

A type-safe, zero-cost wrapper for an OSAL Time Base ID.

Tuple Fields

0: u32

Implementations

impl TimeBaseId

pub fn get_free_run(&self) -> Result<u32>

Reads the value of the timebase free-running counter.

This is a lightweight way to poll a monotonically increasing timer. The absolute value is not relevant, but differences between successive calls can be used for high-resolution timing.

pub fn from_name(name: &str) -> Result<Self>

Finds an existing time base ID by its name.

Trait Implementations

impl Clone for TimeBaseId

fn clone(&self) -> TimeBaseId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeBaseId

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

Formats the value using the given formatter.

impl PartialEq for TimeBaseId

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

impl Eq for TimeBaseId

impl StructuralPartialEq for TimeBaseId