Struct AvrDuration

pub struct AvrDuration { /* private fields */ }

Like std::time::Duration, but in AVR cycles; somewhat approximate¹.

¹ https://github.com/buserror/simavr/blob/b3ea4f93e18fa5059f76060ff718dc544ca48009/simavr/sim/sim_core.c#L621

Implementations

impl AvrDuration

pub const fn new(clock_frequency: u32, cycles: u64) -> Self

Creates a new duration for given clock frequency and number of cycles:

AvrDuration::new(
    16_000_000, /* 16 MHz */
    8_000_000, /* 8 million clock cycles (=500ms here) */
);

If you’re using AvrTester, you might find AvrDurationExt more convenient than this constructor.

pub const fn add_cycles(self, n: u64) -> Self

Returns a new duration with increased number of cycles.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(500, tt.as_millis());
assert_eq!(750, tt.add_cycles(4_000_000).as_millis());

pub const fn add_micros(self, n: u64) -> Self

Returns a new duration with increased number of microseconds.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(500, tt.as_millis());
assert_eq!(501, tt.add_micros(1_000).as_millis());

pub const fn add_millis(self, millis: u64) -> Self

Returns a new duration with increased number of milliseconds.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(500, tt.as_millis());
assert_eq!(515, tt.add_millis(15).as_millis());

pub const fn add_secs(self, secs: u64) -> Self

Returns a new duration with increased number of seconds.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(500, tt.as_millis());
assert_eq!(2500, tt.add_secs(2).as_millis());

pub const fn with_cycles(self, n: u64) -> Self

Returns a new duration with specified number of cycles.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(250, tt.with_cycles(4_000_000).as_millis());

pub const fn with_micros(self, n: u64) -> Self

Returns a new duration with specified number of microseconds.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(1, tt.with_micros(1_000).as_millis());

pub const fn with_millis(self, n: u64) -> Self

Returns a new duration with specified number of milliseconds.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(15, tt.with_millis(15).as_millis());

pub const fn with_secs(self, n: u64) -> Self

Returns a new duration with specified number of seconds.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(2000, tt.with_secs(2).as_millis());

pub const fn clock_frequency(self) -> u32

Returns the clock frequency associated with this duration (e.g. 16 MHz).

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(16_000_000, tt.clock_frequency());

pub const fn as_cycles(self) -> u64

Returns the number of cycles contained by this duration.

Examples

let tt = AvrDuration::new(16_000_000, 8_000_000);

assert_eq!(8_000_000, tt.as_cycles());

let tt = AvrDuration::new(16_000_000, 0).add_secs(3);

assert_eq!(48_000_000, tt.as_cycles());

pub fn as_micros(self) -> u64

Returns the number of microseconds contained by this duration.

Examples

let tt = AvrDuration::new(16_000_000, 40);

assert_eq!(3, tt.as_micros());

pub fn as_micros_f64(self) -> f64

Returns the number of microseconds contained by this duration as f64.

Examples

let tt = AvrDuration::new(16_000_000, 40);

assert_eq!(2.5, tt.as_micros_f64());

pub fn as_millis(self) -> u64

Returns the number of milliseconds contained by this duration.

Examples

let tt = AvrDuration::new(16_000_000, 40_000);

assert_eq!(3, tt.as_millis());

pub fn as_millis_f64(self) -> f64

Returns the number of milliseconds contained by this duration as f64.

Examples

let tt = AvrDuration::new(16_000_000, 40_000);

assert_eq!(2.5, tt.as_millis_f64());

pub fn as_secs(self) -> u64

Returns the number of seconds contained by this duration.

Examples

let tt = AvrDuration::new(16_000_000, 40_000_000);

assert_eq!(3, tt.as_secs());

pub fn as_secs_f64(self) -> f64

Returns the number of seconds contained by this duration as f64.

Examples

let tt = AvrDuration::new(16_000_000, 40_000_000);

assert_eq!(2.5, tt.as_secs_f64());

pub fn is_zero(self) -> bool

Returns whether the number of cycles contained by this duration is zero.

Examples

let tt1 = AvrDuration::new(16_000_000, 0);
let tt2 = AvrDuration::new(16_000_000, 10_000);

assert!(tt1.is_zero());
assert!(!tt2.is_zero());

Trait Implementations

impl Add for AvrDuration

Examples

let a = AvrDuration::new(16_000_000, 1_000);
let b = AvrDuration::new(16_000_000, 2_000);

assert_eq!(
    AvrDuration::new(16_000_000, 3_000),
    a + b,
);

type Output = AvrDuration

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for AvrDuration

Examples

let mut a = AvrDuration::new(16_000_000, 1_000);

a += AvrDuration::new(16_000_000, 2_000);

assert_eq!(AvrDuration::new(16_000_000, 3_000), a);

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for AvrDuration

fn clone(&self) -> AvrDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AvrDuration

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

Formats the value using the given formatter.

impl Display for AvrDuration

Examples

let tt = AvrDuration::new(16_000_000, 0).add_millis(123);

assert_eq!("123000 µs", tt.to_string());

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

Formats the value using the given formatter.

impl Hash for AvrDuration

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 Ord for AvrDuration

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

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

fn partial_cmp(&self, other: &AvrDuration) -> 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 Sub for AvrDuration

Examples

let a = AvrDuration::new(16_000_000, 3_000);
let b = AvrDuration::new(16_000_000, 2_000);

assert_eq!(
    AvrDuration::new(16_000_000, 1_000),
    a - b,
);

let a = AvrDuration::new(16_000_000, 3_000);
let b = AvrDuration::new(16_000_000, 4_000);

assert_eq!(
    AvrDuration::new(16_000_000, 0),
    a - b,
);

type Output = AvrDuration

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for AvrDuration

Examples

let mut a = AvrDuration::new(16_000_000, 3_000);

a -= AvrDuration::new(16_000_000, 2_000);

assert_eq!(AvrDuration::new(16_000_000, 1_000), a);

let mut a = AvrDuration::new(16_000_000, 3_000);

a -= AvrDuration::new(16_000_000, 4_000);

assert_eq!(AvrDuration::new(16_000_000, 0), a);

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for AvrDuration

impl Eq for AvrDuration

impl StructuralPartialEq for AvrDuration