Skip to main content

Duration

Struct Duration 

Source
pub struct Duration(/* private fields */);
Expand description

A signed time interval with nanosecond precision.

Duration represents a span of time and is independent of any time scale, reference system, or calendar.

§Precision

Nanosecond resolution.

§Range

Approximately ±2^63 nanoseconds (~292 years).

§Examples

use gnss_time::Duration;

let a = Duration::from_seconds(1);
let b = Duration::from_millis(500);

assert_eq!(a - b, b);

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

Implementations§

Source§

impl Duration

Source

pub const ZERO: Duration

Zero duration.

Source

pub const MAX: Duration

Maximum representable duration.

Source

pub const MIN: Duration

Minimum representable duration.

Source

pub const ONE_NANOSECOND: Duration

One nanosecond.

Source

pub const ONE_SECOND: Duration

One second.

Source

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

Creates a Duration from nanoseconds.

Source

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

Creates a Duration from microseconds.

Source

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

Creates a Duration from milliseconds.

Source

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

Creates a Duration from seconds.

Source

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

Creates a Duration from minutes.

Source

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

Creates a Duration from hours.

Source

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

Creates a Duration from days.

Source

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

Creates a Duration from microseconds, returning None on overflow.

Source

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

Creates a Duration from milliseconds, returning None on overflow.

Source

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

Creates a Duration from seconds, returning None on overflow.

Source

pub const fn as_nanos(self) -> i64

Returns the raw nanosecond value.

Source

pub const fn as_micros(self) -> i64

Returns whole microseconds (truncated toward zero).

Source

pub const fn as_millis(self) -> i64

Returns whole milliseconds (truncated toward zero).

Source

pub const fn as_seconds(self) -> i64

Returns whole seconds (truncated toward zero).

Source

pub fn as_seconds_f64(self) -> f64

Returns seconds as f64.

Source

pub const fn is_positive(self) -> bool

Returns true if positive.

Source

pub const fn is_negative(self) -> bool

Returns true if negative.

Source

pub const fn is_zero(self) -> bool

Returns true if zero.

Source

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

Returns absolute value, or None on overflow.

Source

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

Checked addition.

Source

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

Checked subtraction.

Source

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

Saturating addition.

Source

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

Saturating subtraction.

Source

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

Fallible addition.

Source

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

Fallible subtraction.

Trait Implementations§

Source§

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

Source§

type Output = Time<S>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl Add for Duration

Source§

type Output = Duration

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

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

Source§

fn add_assign(&mut self, rhs: Duration)

Performs the += operation. Read more
Source§

impl AddAssign for Duration

Source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
Source§

impl Clone for Duration

Source§

fn clone(&self) -> Duration

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Duration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Duration

Source§

fn default() -> Duration

Returns the “default value” for a type. Read more
Source§

impl Display for Duration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Duration

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Neg for Duration

Source§

type Output = Duration

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

impl Ord for Duration

Source§

fn cmp(&self, other: &Duration) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Duration

Source§

fn eq(&self, other: &Duration) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Duration

Source§

fn partial_cmp(&self, other: &Duration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

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

Source§

type Output = Time<S>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl Sub for Duration

Source§

type Output = Duration

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

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

Source§

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation. Read more
Source§

impl SubAssign for Duration

Source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
Source§

impl Copy for Duration

Source§

impl Eq for Duration

Source§

impl StructuralPartialEq for Duration

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.