Struct Duration 

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

A signed time interval measured in nanoseconds.

Duration is domain-agnostic: it represents the difference between two instants and can be added to or subtracted from any crate::Time<S>.

Range

i64 nanoseconds ==> approximately ±292 years.

Examples

use gnss_time::Duration;

let one_sec = Duration::from_seconds(1);
let half_sec = Duration::from_millis(500);

assert_eq!(one_sec - half_sec, half_sec);

let neg = -one_sec;

assert_eq!(neg.as_nanos(), -1_000_000_000);

Implementations

impl Duration

pub const ZERO: Duration

Zero duration.

pub const MAX: Duration

Maximum representable duration (~292 years).

pub const MIN: Duration

Minimum representable duration (~ -292 years).

pub const ONE_NANOSECOND: Duration

One nanosecond.

pub const ONE_SECOND: Duration

One second expressed as a Duration.

pub const fn from_nanos(nanos: i64) -> Self

Create from a raw nanosecond count. Prefer the types constructors below.

pub const fn from_micros(micros: i64) -> Self

Create from whole microseconds.

pub const fn from_millis(millis: i64) -> Self

Create from whole milliseconds.

pub const fn from_seconds(secs: i64) -> Self

Create from whole seconds.

pub const fn from_minutes(mins: i64) -> Self

Create from whole minutes.

pub const fn from_hours(hours: i64) -> Self

Create from whole hours.

pub const fn from_days(days: i64) -> Self

Create from whole days.

pub const fn checked_from_micros(micros: i64) -> Option<Self>

Create from microseconds, returning None on overflow.

pub const fn checked_from_millis(millis: i64) -> Option<Self>

Create from milliseconds, returning None on overflow.

pub const fn checked_from_seconds(secs: i64) -> Option<Self>

Create from whole seconds, returning None on overflow.

impl Duration

pub const fn as_nanos(self) -> i64

Raw nanosecond count (may be negative).

pub const fn as_micros(self) -> i64

Whole microseconds (truncated toward zero).

pub const fn as_millis(self) -> i64

Whole millisecond (truncated toward zero).

pub const fn as_seconds(self) -> i64

Whole seconds (truncated toward zero).

pub fn as_seconds_f64(self) -> f64

Floating-point seconds. Precision is limited by f64 mantissa (~15 significant decimal digits), sufficient for sub-nanosecond accuracy up to ~10 000 seconds.

pub const fn is_positive(self) -> bool

Returns true if the duration is positive (> 0).

pub const fn is_negative(self) -> bool

Returns true if the duration is negative (< 0).

pub const fn is_zero(self) -> bool

Returns true if the duration is zero.

pub const fn abs(self) -> Option<Self>

Absolute value. Returns None for Duration::MIN (no positive counterpart in i64).

impl Duration

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

Add, returning None on overflow.

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

Subtract, returning None on overflow.

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

Add, saturating at i64::MAX / i64::MIN.

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

Subtract, saturating at i64::MAX / i64::MIN.

pub fn try_add(self, rhs: Duration) -> Result<Duration, GnssTimeError>

Fallible addition - returns GnssTimeError::Overflow on overflow.

pub fn try_sub(self, rhs: Duration) -> Result<Duration, GnssTimeError>

Fallible subtraction — returns GnssTimeError::Overflow on overflow.

Trait Implementations

impl<S: TimeScale> Add<Duration> for Time<S>

type Output = Time<S>

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Time<S>

Performs the + operation.

impl Add for Duration

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

Panics / Overflow

In debug builds, panics on overflow. In release builds, wraps around (same semantics as i64).

type Output = Duration

The resulting type after applying the + operator.

impl<S: TimeScale> AddAssign<Duration> for Time<S>

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 duplicate 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 Default for Duration

fn default() -> Duration

Returns the “default value” for a type.

impl Display for Duration

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

Formats as [−]Xs Ynano_s preserving full precision.

Examples: "1s 0ns", "-3s 141592654ns", "0s 500000000ns".

impl Hash for Duration

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 Neg for Duration

type Output = Duration

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - 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,

Restrict a value to a certain interval.

impl PartialEq for Duration

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

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<S: TimeScale> Sub<Duration> for Time<S>

type Output = Time<S>

The resulting type after applying the - operator.

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

Performs the - operation.

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<S: TimeScale> SubAssign<Duration> for Time<S>

fn sub_assign(&mut self, rhs: Duration)

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