Struct TimeInterval

pub struct TimeInterval { /* private fields */ }

An interval or duration of time between two DateTimes.

The easiest way to create a TimeInterval is often with the time_interval macro, which uses a domain-specific language:

Examples

use datetime::interval::TimeInterval;
use datetime::time_interval;

assert_eq!(time_interval!(5m 30s), TimeInterval::new(330, 0));
assert_eq!(time_interval!(-1h 30m), TimeInterval::new(-5_400, 0));
assert_eq!(time_interval!(10.5s), TimeInterval::new(10, 500_000_000));

Implementations

impl TimeInterval

pub const fn new(seconds: i64, nanos: u32) -> Self

Create a new TimeInterval from seconds and nanoseconds.

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

Create a new TimeInterval from a value in milliseconds.

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

Create a new TimeInterval from a value in microseconds.

pub const fn from_nanoseconds(nanos: i128) -> Self

Create a new TimeInterval from a value in nanoseconds.

pub const fn seconds(&self) -> i64

The number of seconds this interval represents.

Note that the nanoseconds value is always positive, even if seconds is negative. For example, an interval representing -2.5 seconds will be represented as -3 seconds and 500,000,000 nanos.

pub const fn nanoseconds(&self) -> u32

The number of nanoseconds this interval represents.

Note that the nanoseconds value is always positive, even if seconds is negative. For example, an interval representing -2.5 seconds will be represented as -3 seconds and 500,000,000 nanos.

pub const fn as_milliseconds(&self) -> i64

The number of milliseconds this interval represents.

pub const fn as_microseconds(&self) -> i64

The number of microseconds this interval represents.

pub const fn as_nanoseconds(&self) -> i128

The number of nanoseconds this interval represents.

Trait Implementations

impl Add<TimeInterval> for DateTime

type Output = DateTime

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<TimeInterval> for DateTime

fn add_assign(&mut self, rhs: TimeInterval)

Performs the += operation.

impl Clone for TimeInterval

fn clone(&self) -> TimeInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeInterval

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

Formats the value using the given formatter.

impl Default for TimeInterval

fn default() -> TimeInterval

Returns the “default value” for a type.

impl<I: Into<i128>> Div<I> for TimeInterval

type Output = TimeInterval

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for TimeInterval

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl<I: Into<i128>> Mul<I> for TimeInterval

type Output = TimeInterval

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for TimeInterval

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

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

Tests for self and other values to be equal, and is used by ==.

const 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 TimeInterval

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

type Output = DateTime

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<TimeInterval> for DateTime

fn sub_assign(&mut self, rhs: TimeInterval)

Performs the -= operation.

impl Copy for TimeInterval

impl Eq for TimeInterval

impl StructuralPartialEq for TimeInterval