Struct Rate

pub struct Rate(/* private fields */);

Represents a rate or frequency of events.

Implementations

impl Rate

pub const fn from_hz(val: u32) -> Self

Shorthand for creating a rate which represents hertz.

Example

use esp_hal::time::Rate;
let rate = Rate::from_hz(1000);

pub const fn from_khz(val: u32) -> Self

Shorthand for creating a rate which represents kilohertz.

Example

use esp_hal::time::Rate;
let rate = Rate::from_khz(1000);

pub const fn from_mhz(val: u32) -> Self

Shorthand for creating a rate which represents megahertz.

Example

use esp_hal::time::Rate;
let rate = Rate::from_mhz(1000);

pub const fn as_hz(&self) -> u32

Convert the Rate to an interger number of Hz.

Example

use esp_hal::time::Rate;
let rate = Rate::from_hz(1000);
let hz = rate.as_hz();

pub const fn as_khz(&self) -> u32

Convert the Rate to an interger number of kHz.

Example

use esp_hal::time::Rate;
let rate = Rate::from_khz(1000);
let khz = rate.as_khz();

pub const fn as_mhz(&self) -> u32

Convert the Rate to an interger number of MHz.

Example

use esp_hal::time::Rate;
let rate = Rate::from_mhz(1000);
let mhz = rate.as_mhz();

pub const fn as_duration(&self) -> Duration

Convert the Rate to a Duration.

Example

use esp_hal::time::Rate;
let rate = Rate::from_hz(1000);
let duration = rate.as_duration();

Trait Implementations

impl Clone for Rate

fn clone(&self) -> Rate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rate

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

Formats the value using the given formatter.

impl Display for Rate

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

Formats the value using the given formatter.

impl Div<u32> for Rate

type Output = Rate

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl Div for Rate

type Output = u32

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl Hash for Rate

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl Mul<u32> for Rate

type Output = Rate

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl Ord for Rate

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

This method returns an [Ordering] between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Rate

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Rate

impl Eq for Rate

impl StructuralPartialEq for Rate