Struct fugit_timer::Duration

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

Represents a duration of time.

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

Implementations

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

pub const fn from_ticks(ticks: u32) -> Duration<u32, NOM, DENOM>

Create a Duration from a ticks value.

let _d = Duration::<u32, 1, 1_000>::from_ticks(1);

pub const fn ticks(&self) -> u32

Extract the ticks from a Duration.

let d = Duration::<u32, 1, 1_000>::from_ticks(234);

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

pub const fn checked_add<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Duration<u32, O_NOM, O_DENOM>
) -> Option<Duration<u32, NOM, DENOM>>

Add two durations while checking for overflow.

let d1 = Duration::<u32, 1, 1_000>::from_ticks(1);
let d2 = Duration::<u32, 1, 1_000>::from_ticks(2);
let d3 = Duration::<u32, 1, 1_000>::from_ticks(u32::MAX);

assert_eq!(d1.checked_add(d2).unwrap().ticks(), 3);
assert_eq!(d1.checked_add(d3), None);

pub const fn checked_sub<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Duration<u32, O_NOM, O_DENOM>
) -> Option<Duration<u32, NOM, DENOM>>

Subtract two durations while checking for overflow.

let d1 = Duration::<u32, 1, 1_000>::from_ticks(1);
let d2 = Duration::<u32, 1, 1_000>::from_ticks(2);
let d3 = Duration::<u32, 1, 1_000>::from_ticks(u32::MAX);

assert_eq!(d2.checked_sub(d1).unwrap().ticks(), 1);
assert_eq!(d1.checked_sub(d3), None);

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

Const partial comparison.

let d1 = Duration::<u32, 1, 1_00>::from_ticks(1);
let d2 = Duration::<u32, 1, 1_000>::from_ticks(1);

assert_eq!(d1.const_partial_cmp(d2), Some(core::cmp::Ordering::Greater));

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

Const equality check.

let d1 = Duration::<u32, 1, 1_00>::from_ticks(1);
let d2 = Duration::<u32, 1, 1_000>::from_ticks(10);

assert!(d1.const_eq(d2));

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

Const try into, checking for overflow.

let d1 = Duration::<u32, 1, 1_00>::from_ticks(1);
let d2: Option<Duration::<u32, 1, 1_000>> = d1.const_try_into();

assert_eq!(d2.unwrap().ticks(), 10);

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

Convert between bases for a duration.

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

let d1 = Duration::<u32, 1, 100>::from_ticks(1);
let d2: Duration::<u32, 1, 1_000> = d1.convert();

assert_eq!(d2.ticks(), 10);

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

const TICKS: u32= u32::MAX - 10;
const D1: Duration::<u32, 1, 100> = Duration::<u32, 1, 100>::from_ticks(TICKS);
// Fails conversion due to tick overflow
const D2: Duration::<u32, 1, 200> = D1.convert();

pub const fn micros(val: u32) -> Duration<u32, NOM, DENOM>

Shorthand for creating a duration which represents microseconds.

pub const fn millis(val: u32) -> Duration<u32, NOM, DENOM>

Shorthand for creating a duration which represents milliseconds.

pub const fn secs(val: u32) -> Duration<u32, NOM, DENOM>

Shorthand for creating a duration which represents seconds.

pub const fn minutes(val: u32) -> Duration<u32, NOM, DENOM>

Shorthand for creating a duration which represents minutes.

pub const fn hours(val: u32) -> Duration<u32, NOM, DENOM>

Shorthand for creating a duration which represents hours.

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

pub const fn from_ticks(ticks: u64) -> Duration<u64, NOM, DENOM>

Create a Duration from a ticks value.

let _d = Duration::<u64, 1, 1_000>::from_ticks(1);

pub const fn ticks(&self) -> u64

Extract the ticks from a Duration.

let d = Duration::<u64, 1, 1_000>::from_ticks(234);

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

pub const fn checked_add<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Duration<u64, O_NOM, O_DENOM>
) -> Option<Duration<u64, NOM, DENOM>>

Add two durations while checking for overflow.

let d1 = Duration::<u64, 1, 1_000>::from_ticks(1);
let d2 = Duration::<u64, 1, 1_000>::from_ticks(2);
let d3 = Duration::<u64, 1, 1_000>::from_ticks(u64::MAX);

assert_eq!(d1.checked_add(d2).unwrap().ticks(), 3);
assert_eq!(d1.checked_add(d3), None);

pub const fn checked_sub<const O_NOM: u32, const O_DENOM: u32>(
    self,
    other: Duration<u64, O_NOM, O_DENOM>
) -> Option<Duration<u64, NOM, DENOM>>

Subtract two durations while checking for overflow.

let d1 = Duration::<u64, 1, 1_000>::from_ticks(1);
let d2 = Duration::<u64, 1, 1_000>::from_ticks(2);
let d3 = Duration::<u64, 1, 1_000>::from_ticks(u64::MAX);

assert_eq!(d2.checked_sub(d1).unwrap().ticks(), 1);
assert_eq!(d1.checked_sub(d3), None);

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

Const partial comparison.

let d1 = Duration::<u64, 1, 1_00>::from_ticks(1);
let d2 = Duration::<u64, 1, 1_000>::from_ticks(1);

assert_eq!(d1.const_partial_cmp(d2), Some(core::cmp::Ordering::Greater));

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

Const equality check.

let d1 = Duration::<u64, 1, 1_00>::from_ticks(1);
let d2 = Duration::<u64, 1, 1_000>::from_ticks(10);

assert!(d1.const_eq(d2));

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

Const try into, checking for overflow.

let d1 = Duration::<u64, 1, 1_00>::from_ticks(1);
let d2: Option<Duration::<u64, 1, 1_000>> = d1.const_try_into();

assert_eq!(d2.unwrap().ticks(), 10);

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

Convert between bases for a duration.

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

let d1 = Duration::<u64, 1, 100>::from_ticks(1);
let d2: Duration::<u64, 1, 1_000> = d1.convert();

assert_eq!(d2.ticks(), 10);

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

const TICKS: u64= u64::MAX - 10;
const D1: Duration::<u64, 1, 100> = Duration::<u64, 1, 100>::from_ticks(TICKS);
// Fails conversion due to tick overflow
const D2: Duration::<u64, 1, 200> = D1.convert();

pub const fn micros(val: u64) -> Duration<u64, NOM, DENOM>

Shorthand for creating a duration which represents microseconds.

pub const fn millis(val: u64) -> Duration<u64, NOM, DENOM>

Shorthand for creating a duration which represents milliseconds.

pub const fn secs(val: u64) -> Duration<u64, NOM, DENOM>

Shorthand for creating a duration which represents seconds.

pub const fn minutes(val: u64) -> Duration<u64, NOM, DENOM>

Shorthand for creating a duration which represents minutes.

pub const fn hours(val: u64) -> Duration<u64, NOM, DENOM>

Shorthand for creating a duration which represents hours.

Trait Implementations

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

type Output = Duration<u64, NOM, DENOM>

The resulting type after applying the + operator.

pub fn add(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Duration<u64, NOM, DENOM> as Add<Duration<u32, NOM, DENOM>>>::Output

Performs the + operation.

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

type Output = Instant<u64, NOM, DENOM>

The resulting type after applying the + operator.

pub fn add(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Instant<u64, NOM, DENOM> as Add<Duration<u32, NOM, DENOM>>>::Output

Performs the + operation.

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

type Output = Duration<u32, NOM, DENOM>

The resulting type after applying the + operator.

pub fn add(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Duration<u32, NOM, DENOM> as Add<Duration<u32, NOM, DENOM>>>::Output

Performs the + operation.

impl<const NOM: u32, const DENOM: u32> Add<Duration<u32, NOM, DENOM>> for Instant<u32, NOM, DENOM>

type Output = Instant<u32, NOM, DENOM>

The resulting type after applying the + operator.

pub fn add(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Instant<u32, NOM, DENOM> as Add<Duration<u32, NOM, DENOM>>>::Output

Performs the + operation.

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

type Output = Duration<u64, NOM, DENOM>

The resulting type after applying the + operator.

pub fn add(
    self,
    other: Duration<u64, NOM, DENOM>
) -> <Duration<u64, NOM, DENOM> as Add<Duration<u64, NOM, DENOM>>>::Output

Performs the + operation.

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

type Output = Instant<u64, NOM, DENOM>

The resulting type after applying the + operator.

pub fn add(
    self,
    other: Duration<u64, NOM, DENOM>
) -> <Instant<u64, NOM, DENOM> as Add<Duration<u64, NOM, DENOM>>>::Output

Performs the + operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

type Output = Duration<u64, NOM, DENOM>

The resulting type after applying the / operator.

pub fn div(self, other: u32) -> <Duration<u64, NOM, DENOM> as Div<u32>>::Output

Performs the / operation.

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

type Output = Duration<u32, NOM, DENOM>

The resulting type after applying the / operator.

pub fn div(self, other: u32) -> <Duration<u32, NOM, DENOM> as Div<u32>>::Output

Performs the / operation.

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

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

Performs the conversion.

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

type Output = Duration<u32, NOM, DENOM>

The resulting type after applying the * operator.

pub fn mul(self, other: u32) -> <Duration<u32, NOM, DENOM> as Mul<u32>>::Output

Performs the * operation.

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

type Output = Duration<u64, NOM, DENOM>

The resulting type after applying the * operator.

pub fn mul(self, other: u32) -> <Duration<u64, NOM, DENOM> as Mul<u32>>::Output

Performs the * operation.

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

pub fn cmp(&self, other: &Duration<u32, NOM, DENOM>) -> 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 Duration<u64, NOM, DENOM>

pub fn cmp(&self, other: &Duration<u64, NOM, DENOM>) -> 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<Duration<u32, R_NOM, R_DENOM>> for Duration<u64, L_NOM, L_DENOM>

pub fn eq(&self, other: &Duration<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<Duration<u32, R_NOM, R_DENOM>> for Duration<u32, L_NOM, L_DENOM>

pub fn eq(&self, other: &Duration<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<Duration<u64, R_NOM, R_DENOM>> for Duration<u64, L_NOM, L_DENOM>

pub fn eq(&self, other: &Duration<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<Duration<u64, R_NOM, R_DENOM>> for Duration<u32, L_NOM, L_DENOM>

pub fn eq(&self, other: &Duration<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<Duration<u32, R_NOM, R_DENOM>> for Duration<u64, L_NOM, L_DENOM>

pub fn partial_cmp(
    &self,
    other: &Duration<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<Duration<u32, R_NOM, R_DENOM>> for Duration<u32, L_NOM, L_DENOM>

pub fn partial_cmp(
    &self,
    other: &Duration<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<Duration<u64, R_NOM, R_DENOM>> for Duration<u64, L_NOM, L_DENOM>

pub fn partial_cmp(
    &self,
    other: &Duration<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<Duration<u64, R_NOM, R_DENOM>> for Duration<u32, L_NOM, L_DENOM>

pub fn partial_cmp(
    &self,
    other: &Duration<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<Duration<u32, NOM, DENOM>> for Instant<u32, NOM, DENOM>

type Output = Instant<u32, NOM, DENOM>

The resulting type after applying the - operator.

pub fn sub(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Instant<u32, NOM, DENOM> as Sub<Duration<u32, NOM, DENOM>>>::Output

Performs the - operation.

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

type Output = Instant<u64, NOM, DENOM>

The resulting type after applying the - operator.

pub fn sub(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Instant<u64, NOM, DENOM> as Sub<Duration<u32, NOM, DENOM>>>::Output

Performs the - operation.

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

type Output = Duration<u64, NOM, DENOM>

The resulting type after applying the - operator.

pub fn sub(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Duration<u64, NOM, DENOM> as Sub<Duration<u32, NOM, DENOM>>>::Output

Performs the - operation.

impl<const NOM: u32, const DENOM: u32> Sub<Duration<u32, NOM, DENOM>> for Duration<u32, NOM, DENOM>

type Output = Duration<u32, NOM, DENOM>

The resulting type after applying the - operator.

pub fn sub(
    self,
    other: Duration<u32, NOM, DENOM>
) -> <Duration<u32, NOM, DENOM> as Sub<Duration<u32, NOM, DENOM>>>::Output

Performs the - operation.

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

type Output = Instant<u64, NOM, DENOM>

The resulting type after applying the - operator.

pub fn sub(
    self,
    other: Duration<u64, NOM, DENOM>
) -> <Instant<u64, NOM, DENOM> as Sub<Duration<u64, NOM, DENOM>>>::Output

Performs the - operation.

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

type Output = Duration<u64, NOM, DENOM>

The resulting type after applying the - operator.

pub fn sub(
    self,
    other: Duration<u64, NOM, DENOM>
) -> <Duration<u64, NOM, DENOM> as Sub<Duration<u64, NOM, DENOM>>>::Output

Performs the - operation.

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

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