Struct ticklock::clock::Frequency

pub struct Frequency { /* fields omitted */ }

Frequency abstraction

Using the frequency we can calculate duration

Methods

impl Frequency

pub const fn tick(&self) -> Duration

Return the duration of single clock pulse.

pub const fn ticks_in(&self, d: Duration) -> u64

Return the number of entire clock pulse within a duration

pub fn into_hertz(&self) -> Frequency

Change the frequency range in Hz. This is useful only for printing.

pub fn into_kilo(&self) -> Frequency

Change the frequency range in KHz. This is useful only for printing.

pub fn into_mega(&self) -> Frequency

Change the frequency range in MHz. This is useful only for printing.

pub fn into_milli(&self) -> Frequency

Change the frequency range in mhz. This is useful only for printing.

Trait Implementations

impl Clone for Frequency

fn clone(&self) -> Frequency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Frequency> for Frequency

fn eq(&self, other: &Frequency) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Eq for Frequency

impl Ord for Frequency

fn cmp(&self, other: &Frequency) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl PartialOrd<Frequency> for Frequency

fn partial_cmp(&self, other: &Frequency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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 Copy for Frequency

impl Debug for Frequency

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

Formats the value using the given formatter.

impl Div<u32> for Frequency

type Output = Frequency

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Frequency

Allow to scale down a frequency

impl Div<Frequency> for Frequency

type Output = u32

The resulting type after applying the / operator.

fn div(self, rhs: Frequency) -> u32

Give the scale between 2 frequency. Particularly useful for selecting pre-scale value on MCU.