Struct femtos::Duration

pub struct Duration { /* private fields */ }

Represents a duration of time in femtoseconds

The Duration type is used to represent lengths of time and is intentionally similar to std::time::Duration, but which records time as femtoseconds to keep accurancy when dealing with partial nanosecond clock divisons.

Implementations

impl Duration

pub const ZERO: Self = _

A duration of zero (0) time

pub const MAX: Self = _

A duration of the maximum possible length in femtoseconds (Femtos::MAX)

This will be equivalent to either u64::MAX or u128::MAX femtoseconds

pub const FEMTOS_PER_SEC: Femtos = 1_000_000_000_000_000u128

The number of femtoseconds in 1 second as Femtos

pub const FEMTOS_PER_MILLISEC: Femtos = 1_000_000_000_000u128

The number of femtoseconds in 1 millisecond as Femtos

pub const FEMTOS_PER_MICROSEC: Femtos = 1_000_000_000u128

The number of femtoseconds in 1 microsecond as Femtos

pub const FEMTOS_PER_NANOSEC: Femtos = 1_000_000u128

The number of femtoseconds in 1 nanosecond as Femtos

pub const FEMTOS_PER_PICOSEC: Femtos = 1_000u128

The number of femtoseconds in 1 picosecond as Femtos

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

Creates a new Duration from the specified number of seconds

Examples

use femtos::Duration;

let duration = Duration::from_secs(123);

assert_eq!(123, duration.as_secs());

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

Creates a new Duration from the specified number of milliseconds

Examples

use femtos::Duration;

let duration = Duration::from_millis(123);

assert_eq!(123, duration.as_millis());

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

Creates a new Duration from the specified number of microseconds

Examples

use femtos::Duration;

let duration = Duration::from_micros(123);

assert_eq!(123, duration.as_micros());

pub const fn from_nanos(nanosecs: u64) -> Self

Creates a new Duration from the specified number of nanoseconds

Examples

use femtos::Duration;

let duration = Duration::from_nanos(123);

assert_eq!(123, duration.as_nanos());

pub const fn from_picos(picosecs: u128) -> Self

Creates a new Duration from the specified number of picoseconds

Examples

use femtos::Duration;

let duration = Duration::from_picos(123);

assert_eq!(123, duration.as_picos());

pub const fn from_femtos(femtos: Femtos) -> Self

Creates a new Duration from the specified number of femtoseconds

Examples

use femtos::Duration;

let duration = Duration::from_femtos(123);

assert_eq!(123, duration.as_femtos());

pub const fn as_secs(self) -> u64

Returns the number of whole seconds contained by this Duration.

Examples

use femtos::Duration;

let duration = Duration::from_femtos(123_465_789_012_345_678);
assert_eq!(duration.as_secs(), 123);

pub const fn as_millis(self) -> u64

Returns the number of whole milliseconds contained by this Duration.

Examples

use femtos::Duration;

let duration = Duration::from_femtos(123_465_789_012_345_678);
assert_eq!(duration.as_millis(), 123_465);

pub const fn as_micros(self) -> u64

Returns the number of whole microseconds contained by this Duration.

Examples

use femtos::Duration;

let duration = Duration::from_femtos(123_465_789_012_345_678);
assert_eq!(duration.as_micros(), 123_465_789);

pub const fn as_nanos(self) -> u64

Returns the number of whole nanoseconds contained by this Duration.

Examples

use femtos::Duration;

let duration = Duration::from_femtos(123_465_789_012_345_678);
assert_eq!(duration.as_nanos(), 123_465_789_012);

pub const fn as_picos(self) -> u128

Returns the number of whole picoseconds contained by this Duration.

Examples

use femtos::Duration;

let duration = Duration::from_femtos(123_465_789_012_345_678);
assert_eq!(duration.as_picos(), 123_465_789_012_345);

pub const fn as_femtos(self) -> Femtos

Returns the number of whole femtoseconds contained by this Duration.

Examples

use femtos::Duration;

let duration = Duration::from_femtos(123_465_789_012_345_678);
assert_eq!(duration.as_femtos(), 123_465_789_012_345_678);

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

Checked Duration addition. Computes self + rhs, returning None if an overflow occured.

Examples

use femtos::{Duration, Femtos};

assert_eq!(Duration::from_secs(1).checked_add(Duration::from_secs(1)), Some(Duration::from_secs(2)));
assert_eq!(Duration::from_secs(1).checked_add(Duration::from_femtos(Femtos::MAX)), None);

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

Checked Duration subtraction. Computes self - rhs, returning None if an overflow occured.

Examples

use femtos::Duration;

assert_eq!(Duration::from_secs(1).checked_sub(Duration::from_secs(1)), Some(Duration::ZERO));
assert_eq!(Duration::from_femtos(1).checked_sub(Duration::from_femtos(2)), None);

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl AddAssign for Duration

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Duration

fn clone(&self) -> Duration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Duration

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

Formats the value using the given formatter.

impl Div<u32> for Duration

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<u64> for Duration

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Duration

type Output = u64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<u32> for Duration

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl DivAssign<u64> for Duration

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl From<Duration> for Duration

fn from(value: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for Duration

fn from(value: Duration) -> Self

Converts to this type from the input type.

impl Mul<u32> for Duration

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for Duration

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<u32> for Duration

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

impl MulAssign<u64> for Duration

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl Ord for Duration

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

Restrict a value to a certain interval.

impl PartialEq for Duration

fn eq(&self, other: &Duration) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Duration

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

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Duration

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration