Struct fugit::Rate

pub struct Rate<T, const NOM: u32, const DENOM: u32> { /* private fields */ }

Represents a frequency.

The generic T can either be u32 or u64, and the const generics represent the ratio of the raw contained within the rate: rate in Hz = NOM / DENOM * raw

Implementations

impl<const NOM: u32, const DENOM: u32> Rate<u32, NOM, DENOM>

pub const fn from_raw(raw: u32) -> Self

Create a Rate from a raw value.

let _d = Rate::<u32, 1, 1_000>::from_raw(1);

pub const fn raw(&self) -> u32

Extract the raw value from a Rate.

let d = Rate::<u32, 1, 1_000>::from_raw(234);

assert_eq!(d.raw(), 234);

pub const fn checked_add<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Rate<u32, O_NOM, O_DENOM>
) -> Option<Self>

Add two rates while checking for overflow.

let r1 = Rate::<u32, 1, 1_000>::from_raw(1);
let r2 = Rate::<u32, 1, 1_000>::from_raw(2);
let r3 = Rate::<u32, 1, 1_000>::from_raw(u32::MAX);

assert_eq!(r1.checked_add(r2).unwrap().raw(), 3);
assert_eq!(r1.checked_add(r3), None);

pub const fn checked_sub<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Rate<u32, O_NOM, O_DENOM>
) -> Option<Self>

Subtract two rates while checking for overflow.

let r1 = Rate::<u32, 1, 1_000>::from_raw(1);
let r2 = Rate::<u32, 1, 1_000>::from_raw(2);
let r3 = Rate::<u32, 1, 1_000>::from_raw(u32::MAX);

assert_eq!(r2.checked_sub(r1).unwrap().raw(), 1);
assert_eq!(r1.checked_sub(r3), None);

pub const fn const_partial_cmp<const R_NOM: u32, const R_DENOM: u32>(
    self,
    other: Rate<u32, R_NOM, R_DENOM>
) -> Option<Ordering>

Const partial comparison.

let r1 = Rate::<u32, 1, 1_00>::from_raw(1);
let r2 = Rate::<u32, 1, 1_000>::from_raw(1);

assert_eq!(r1.const_partial_cmp(r2), Some(core::cmp::Ordering::Greater));

pub const fn const_eq<const R_NOM: u32, const R_DENOM: u32>(
    self,
    other: Rate<u32, R_NOM, R_DENOM>
) -> bool

Const equality check.

let r1 = Rate::<u32, 1, 1_00>::from_raw(1);
let r2 = Rate::<u32, 1, 1_000>::from_raw(10);

assert!(r1.const_eq(r2));

pub const fn const_try_into<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Option<Rate<u32, O_NOM, O_DENOM>>

Const try into, checking for overflow.

let r1 = Rate::<u32, 1, 1_00>::from_raw(1);
let r2: Option<Rate::<u32, 1, 1_000>> = r1.const_try_into();

assert_eq!(r2.unwrap().raw(), 10);

pub const fn try_into_duration<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Option<Duration<u32, O_NOM, O_DENOM>>

Const try into duration, checking for divide-by-zero.

let r1 = Rate::<u32, 1, 1>::from_raw(1);
let d1: Option<Duration::<u32, 1, 1_000>> = r1.try_into_duration();

assert_eq!(d1.unwrap().ticks(), 1_000);

pub const fn convert<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Rate<u32, O_NOM, O_DENOM>

Convert between bases for a rate.

Unfortunately not a From impl due to collision with the std lib.

let r1 = Rate::<u32, 1, 100>::from_raw(1);
let r2: Rate::<u32, 1, 1_000> = r1.convert();

assert_eq!(r2.raw(), 10);

Can be used in const contexts. Compilation will fail if the conversion causes overflow

const raw: u32= u32::MAX - 10;
const r1: Rate::<u32, 1, 100> = Rate::<u32, 1, 100>::from_raw(raw);
// Fails conversion due to overflow
const r2: Rate::<u32, 1, 200> = r1.convert();

pub const fn into_duration<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Duration<u32, O_NOM, O_DENOM>

Convert from rate to duration.

pub const fn to_Hz(&self) -> Rate<u32, NOM, DENOM>

Convert the Rate to Hz.

pub const fn to_kHz(&self) -> Rate<u32, NOM, DENOM>

Convert the Rate to kHz.

pub const fn to_MHz(&self) -> Rate<u32, NOM, DENOM>

Convert the Rate to MHz.

pub const fn Hz(val: u32) -> Rate<u32, NOM, DENOM>

Shorthand for creating a rate which represents hertz.

pub const fn kHz(val: u32) -> Rate<u32, NOM, DENOM>

Shorthand for creating a rate which represents kilohertz.

pub const fn MHz(val: u32) -> Rate<u32, NOM, DENOM>

Shorthand for creating a rate which represents megahertz.

impl<const NOM: u32, const DENOM: u32> Rate<u64, NOM, DENOM>

pub const fn from_raw(raw: u64) -> Self

Create a Rate from a raw value.

let _d = Rate::<u64, 1, 1_000>::from_raw(1);

pub const fn raw(&self) -> u64

Extract the raw value from a Rate.

let d = Rate::<u64, 1, 1_000>::from_raw(234);

assert_eq!(d.raw(), 234);

pub const fn checked_add<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Rate<u64, O_NOM, O_DENOM>
) -> Option<Self>

Add two rates while checking for overflow.

let r1 = Rate::<u64, 1, 1_000>::from_raw(1);
let r2 = Rate::<u64, 1, 1_000>::from_raw(2);
let r3 = Rate::<u64, 1, 1_000>::from_raw(u64::MAX);

assert_eq!(r1.checked_add(r2).unwrap().raw(), 3);
assert_eq!(r1.checked_add(r3), None);

pub const fn checked_sub<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Rate<u64, O_NOM, O_DENOM>
) -> Option<Self>

Subtract two rates while checking for overflow.

let r1 = Rate::<u64, 1, 1_000>::from_raw(1);
let r2 = Rate::<u64, 1, 1_000>::from_raw(2);
let r3 = Rate::<u64, 1, 1_000>::from_raw(u64::MAX);

assert_eq!(r2.checked_sub(r1).unwrap().raw(), 1);
assert_eq!(r1.checked_sub(r3), None);

pub const fn const_partial_cmp<const R_NOM: u32, const R_DENOM: u32>(
    self,
    other: Rate<u64, R_NOM, R_DENOM>
) -> Option<Ordering>

Const partial comparison.

let r1 = Rate::<u64, 1, 1_00>::from_raw(1);
let r2 = Rate::<u64, 1, 1_000>::from_raw(1);

assert_eq!(r1.const_partial_cmp(r2), Some(core::cmp::Ordering::Greater));

pub const fn const_eq<const R_NOM: u32, const R_DENOM: u32>(
    self,
    other: Rate<u64, R_NOM, R_DENOM>
) -> bool

Const equality check.

let r1 = Rate::<u64, 1, 1_00>::from_raw(1);
let r2 = Rate::<u64, 1, 1_000>::from_raw(10);

assert!(r1.const_eq(r2));

pub const fn const_try_into<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Option<Rate<u64, O_NOM, O_DENOM>>

Const try into, checking for overflow.

let r1 = Rate::<u64, 1, 1_00>::from_raw(1);
let r2: Option<Rate::<u64, 1, 1_000>> = r1.const_try_into();

assert_eq!(r2.unwrap().raw(), 10);

pub const fn try_into_duration<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Option<Duration<u64, O_NOM, O_DENOM>>

Const try into duration, checking for divide-by-zero.

let r1 = Rate::<u64, 1, 1>::from_raw(1);
let d1: Option<Duration::<u64, 1, 1_000>> = r1.try_into_duration();

assert_eq!(d1.unwrap().ticks(), 1_000);

pub const fn convert<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Rate<u64, O_NOM, O_DENOM>

Convert between bases for a rate.

Unfortunately not a From impl due to collision with the std lib.

let r1 = Rate::<u64, 1, 100>::from_raw(1);
let r2: Rate::<u64, 1, 1_000> = r1.convert();

assert_eq!(r2.raw(), 10);

Can be used in const contexts. Compilation will fail if the conversion causes overflow

const raw: u64= u64::MAX - 10;
const r1: Rate::<u64, 1, 100> = Rate::<u64, 1, 100>::from_raw(raw);
// Fails conversion due to overflow
const r2: Rate::<u64, 1, 200> = r1.convert();

pub const fn into_duration<const O_NOM: u32, const O_DENOM: u32>(
    self
) -> Duration<u64, O_NOM, O_DENOM>

Convert from rate to duration.

pub const fn to_Hz(&self) -> Rate<u64, NOM, DENOM>

Convert the Rate to Hz.

pub const fn to_kHz(&self) -> Rate<u64, NOM, DENOM>

Convert the Rate to kHz.

pub const fn to_MHz(&self) -> Rate<u64, NOM, DENOM>

Convert the Rate to MHz.

pub const fn Hz(val: u64) -> Rate<u64, NOM, DENOM>

Shorthand for creating a rate which represents hertz.

pub const fn kHz(val: u64) -> Rate<u64, NOM, DENOM>

Shorthand for creating a rate which represents kilohertz.

pub const fn MHz(val: u64) -> Rate<u64, NOM, DENOM>

Shorthand for creating a rate which represents megahertz.

Trait Implementations

impl<const NOM: u32, const DENOM: u32> Add<Rate<u32, NOM, DENOM>> for Rate<u32, NOM, DENOM>

type Output = Rate<u32, NOM, DENOM>

The resulting type after applying the + operator.

fn add(self, other: Rate<u32, NOM, DENOM>) -> Self::Output

Performs the + operation.

impl<const NOM: u32, const DENOM: u32> Add<Rate<u32, NOM, DENOM>> for Rate<u64, NOM, DENOM>

type Output = Rate<u64, NOM, DENOM>

The resulting type after applying the + operator.

fn add(self, other: Rate<u32, NOM, DENOM>) -> Self::Output

Performs the + operation.

impl<const NOM: u32, const DENOM: u32> Add<Rate<u64, NOM, DENOM>> for Rate<u64, NOM, DENOM>

type Output = Rate<u64, NOM, DENOM>

The resulting type after applying the + operator.

fn add(self, other: Rate<u64, NOM, DENOM>) -> Self::Output

Performs the + operation.

impl<const NOM: u32, const DENOM: u32> AddAssign<Rate<u32, NOM, DENOM>> for Rate<u32, NOM, DENOM>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<const NOM: u32, const DENOM: u32> AddAssign<Rate<u32, NOM, DENOM>> for Rate<u64, NOM, DENOM>

fn add_assign(&mut self, other: Rate<u32, NOM, DENOM>)

Performs the += operation.

impl<const NOM: u32, const DENOM: u32> AddAssign<Rate<u64, NOM, DENOM>> for Rate<u64, NOM, DENOM>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Clone, const NOM: u32, const DENOM: u32> Clone for Rate<T, NOM, DENOM>

fn clone(&self) -> Rate<T, NOM, DENOM>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const NOM: u32, const DENOM: u32> Debug for Rate<T, NOM, DENOM>

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

Formats the value using the given formatter.

impl<const NOM: u32, const DENOM: u32> Display for Rate<u32, NOM, DENOM>

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

Formats the value using the given formatter.

impl<const NOM: u32, const DENOM: u32> Display for Rate<u64, NOM, DENOM>

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

Formats the value using the given formatter.

impl<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> Div<Rate<u32, R_NOM, R_DENOM>> for Rate<u32, L_NOM, L_DENOM>

type Output = u32

The resulting type after applying the / operator.

fn div(self, other: Rate<u32, R_NOM, R_DENOM>) -> Self::Output

Performs the / operation.

impl<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> Div<Rate<u64, R_NOM, R_DENOM>> for Rate<u64, L_NOM, L_DENOM>

type Output = u64

The resulting type after applying the / operator.

fn div(self, other: Rate<u64, R_NOM, R_DENOM>) -> Self::Output

Performs the / operation.

impl<const NOM: u32, const DENOM: u32> Div<u32> for Rate<u32, NOM, DENOM>

type Output = Rate<u32, NOM, DENOM>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const NOM: u32, const DENOM: u32> Div<u32> for Rate<u64, NOM, DENOM>

type Output = Rate<u64, NOM, DENOM>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const NOM: u32, const DENOM: u32> DivAssign<u32> for Rate<u32, NOM, DENOM>

fn div_assign(&mut self, other: u32)

Performs the /= operation.

impl<const NOM: u32, const DENOM: u32> DivAssign<u32> for Rate<u64, NOM, DENOM>

fn div_assign(&mut self, other: u32)

Performs the /= operation.

impl<const NOM: u32, const DENOM: u32> Format for Rate<u32, NOM, DENOM>

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<const NOM: u32, const DENOM: u32> Format for Rate<u64, NOM, DENOM>

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<const NOM: u32, const DENOM: u32> From<Rate<u32, NOM, DENOM>> for Rate<u64, NOM, DENOM>

fn from(val: Rate<u32, NOM, DENOM>) -> Rate<u64, NOM, DENOM>

Performs the conversion.

impl<const NOM: u32, const DENOM: u32> Mul<Rate<u32, NOM, DENOM>> for u32

type Output = Rate<u32, NOM, DENOM>

The resulting type after applying the * operator.

fn mul(self, other: Rate<u32, NOM, DENOM>) -> Self::Output

Performs the * operation.

impl<const NOM: u32, const DENOM: u32> Mul<Rate<u64, NOM, DENOM>> for u32

type Output = Rate<u64, NOM, DENOM>

The resulting type after applying the * operator.

fn mul(self, other: Rate<u64, NOM, DENOM>) -> Self::Output

Performs the * operation.

impl<const NOM: u32, const DENOM: u32> Mul<u32> for Rate<u32, NOM, DENOM>

type Output = Rate<u32, NOM, DENOM>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const NOM: u32, const DENOM: u32> Mul<u32> for Rate<u64, NOM, DENOM>

type Output = Rate<u64, NOM, DENOM>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const NOM: u32, const DENOM: u32> MulAssign<u32> for Rate<u32, NOM, DENOM>

fn mul_assign(&mut self, other: u32)

Performs the *= operation.

impl<const NOM: u32, const DENOM: u32> MulAssign<u32> for Rate<u64, NOM, DENOM>

fn mul_assign(&mut self, other: u32)

Performs the *= operation.

impl<const NOM: u32, const DENOM: u32> Ord for Rate<u32, NOM, DENOM>

fn cmp(&self, other: &Self) -> 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

Restrict a value to a certain interval.

impl<const NOM: u32, const DENOM: u32> Ord for Rate<u64, NOM, DENOM>

fn cmp(&self, other: &Self) -> 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

Restrict a value to a certain interval.

impl<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialEq<Rate<u32, R_NOM, R_DENOM>> for Rate<u32, L_NOM, L_DENOM>

fn eq(&self, other: &Rate<u32, R_NOM, R_DENOM>) -> bool

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

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

This method tests for !=.

impl<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialEq<Rate<u32, R_NOM, R_DENOM>> for Rate<u64, L_NOM, L_DENOM>

fn eq(&self, other: &Rate<u32, R_NOM, R_DENOM>) -> bool

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

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

This method tests for !=.

impl<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialEq<Rate<u64, R_NOM, R_DENOM>> for Rate<u64, L_NOM, L_DENOM>

fn eq(&self, other: &Rate<u64, R_NOM, R_DENOM>) -> bool

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

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

This method tests for !=.

impl<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialEq<Rate<u64, R_NOM, R_DENOM>> for Rate<u32, L_NOM, L_DENOM>

fn eq(&self, other: &Rate<u64, R_NOM, R_DENOM>) -> bool

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

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

This method tests for !=.

impl<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialOrd<Rate<u32, R_NOM, R_DENOM>> for Rate<u32, L_NOM, L_DENOM>

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

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

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

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

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

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

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

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

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<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialOrd<Rate<u32, R_NOM, R_DENOM>> for Rate<u64, L_NOM, L_DENOM>

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

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

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

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

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

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

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

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

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<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialOrd<Rate<u64, R_NOM, R_DENOM>> for Rate<u64, L_NOM, L_DENOM>

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

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

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

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

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

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

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

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

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<const L_NOM: u32, const L_DENOM: u32, const R_NOM: u32, const R_DENOM: u32> PartialOrd<Rate<u64, R_NOM, R_DENOM>> for Rate<u32, L_NOM, L_DENOM>

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

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

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

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

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

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

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

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

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<const NOM: u32, const DENOM: u32> Sub<Rate<u32, NOM, DENOM>> for Rate<u32, NOM, DENOM>

type Output = Rate<u32, NOM, DENOM>

The resulting type after applying the - operator.

fn sub(self, other: Rate<u32, NOM, DENOM>) -> Self::Output

Performs the - operation.

impl<const NOM: u32, const DENOM: u32> Sub<Rate<u32, NOM, DENOM>> for Rate<u64, NOM, DENOM>

type Output = Rate<u64, NOM, DENOM>

The resulting type after applying the - operator.

fn sub(self, other: Rate<u32, NOM, DENOM>) -> Self::Output

Performs the - operation.

impl<const NOM: u32, const DENOM: u32> Sub<Rate<u64, NOM, DENOM>> for Rate<u64, NOM, DENOM>

type Output = Rate<u64, NOM, DENOM>

The resulting type after applying the - operator.

fn sub(self, other: Rate<u64, NOM, DENOM>) -> Self::Output

Performs the - operation.

impl<const NOM: u32, const DENOM: u32> SubAssign<Rate<u32, NOM, DENOM>> for Rate<u64, NOM, DENOM>

fn sub_assign(&mut self, other: Rate<u32, NOM, DENOM>)

Performs the -= operation.

impl<const NOM: u32, const DENOM: u32> TryFrom<Rate<u64, NOM, DENOM>> for Rate<u32, NOM, DENOM>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: Rate<u64, NOM, DENOM>) -> Result<Rate<u32, NOM, DENOM>, ()>

Performs the conversion.

impl<T: Copy, const NOM: u32, const DENOM: u32> Copy for Rate<T, NOM, DENOM>

impl<const NOM: u32, const DENOM: u32> Eq for Rate<u32, NOM, DENOM>

impl<const NOM: u32, const DENOM: u32> Eq for Rate<u64, NOM, DENOM>