Struct Duration

Source

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

Expand description

Represents a duration of time.

Implementations§

Source §

impl Duration

Source

pub const ZERO: Self

A duration of zero time.

Source

pub const MAX: Self

A duration representing the maximum possible time.

Source

pub const fn from_micros(val: u64) -> Self

Creates a duration which represents microseconds.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_micros(1000);

Source

pub const fn from_millis(val: u64) -> Self

Creates a duration which represents milliseconds.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_millis(100);

Source

pub const fn from_secs(val: u64) -> Self

Creates a duration which represents seconds.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_secs(1);

Source

pub const fn from_minutes(val: u64) -> Self

Creates a duration which represents minutes.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_minutes(1);

Source

pub const fn from_hours(val: u64) -> Self

Creates a duration which represents hours.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_hours(1);

Source

pub const fn as_micros(&self) -> u64

Convert the Duration to an interger number of microseconds.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_micros(1000);
let micros = duration.as_micros();

Source

pub const fn as_millis(&self) -> u64

Convert the Duration to an interger number of milliseconds.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_millis(100);
let millis = duration.as_millis();

Source

pub const fn as_secs(&self) -> u64

Convert the Duration to an interger number of seconds.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_secs(1);
let secs = duration.as_secs();

Source

pub const fn as_minutes(&self) -> u64

Convert the Duration to an interger number of minutes.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_minutes(1);
let minutes = duration.as_minutes();

Source

pub const fn as_hours(&self) -> u64

Convert the Duration to an interger number of hours.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_hours(1);
let hours = duration.as_hours();

Source

pub const fn checked_add(self, rhs: Self) -> Option<Self>

Add two durations while checking for overflow.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_secs(1);
let duration2 = Duration::from_secs(2);

if let Some(sum) = duration.checked_add(duration2) {
    println!("Sum: {}", sum);
} else {
    println!("Overflow occurred");
}

Source

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

Subtract two durations while checking for overflow.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_secs(3);
let duration2 = Duration::from_secs(1);

if let Some(diff) = duration.checked_sub(duration2) {
    println!("Difference: {}", diff);
} else {
    println!("Underflow occurred");
}

Source

pub const fn saturating_add(self, rhs: Self) -> Self

Add two durations, returning the maximum value if overflow occurred.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_secs(1);
let duration2 = Duration::from_secs(2);

let sum = duration.saturating_add(duration2);

Source

pub const fn saturating_sub(self, rhs: Self) -> Self

Subtract two durations, returning the minimum value if the result would be negative.

§Example

use esp_hal::time::Duration;
let duration = Duration::from_secs(3);
let duration2 = Duration::from_secs(1);

let diff = duration.saturating_sub(duration2);