Struct chrono::duration::Duration

pub struct Duration { /* fields omitted */ }

ISO 8601 time duration with nanosecond precision. This also allows for the negative duration; see individual methods for details.

Methods

impl Duration

pub fn weeks(weeks: i64) -> Duration

Makes a new Duration with given number of weeks. Equivalent to Duration::seconds(weeks * 7 * 24 * 60 * 60) with overflow checks. Panics when the duration is out of bounds.

pub fn days(days: i64) -> Duration

Makes a new Duration with given number of days. Equivalent to Duration::seconds(days * 24 * 60 * 60) with overflow checks. Panics when the duration is out of bounds.

pub fn hours(hours: i64) -> Duration

Makes a new Duration with given number of hours. Equivalent to Duration::seconds(hours * 60 * 60) with overflow checks. Panics when the duration is out of bounds.

pub fn minutes(minutes: i64) -> Duration

Makes a new Duration with given number of minutes. Equivalent to Duration::seconds(minutes * 60) with overflow checks. Panics when the duration is out of bounds.

pub fn seconds(seconds: i64) -> Duration

Makes a new Duration with given number of seconds. Panics when the duration is more than i64::MAX milliseconds or less than i64::MIN milliseconds.

pub fn milliseconds(milliseconds: i64) -> Duration

Makes a new Duration with given number of milliseconds.

pub fn microseconds(microseconds: i64) -> Duration

Makes a new Duration with given number of microseconds.

pub fn nanoseconds(nanos: i64) -> Duration

Makes a new Duration with given number of nanoseconds.

pub fn span<F>(f: F) -> Duration where
    F: FnOnce(), 

Runs a closure, returning the duration of time it took to run the closure.

pub fn num_weeks(&self) -> i64

Returns the total number of whole weeks in the duration.

pub fn num_days(&self) -> i64

Returns the total number of whole days in the duration.

pub fn num_hours(&self) -> i64

Returns the total number of whole hours in the duration.

pub fn num_minutes(&self) -> i64

Returns the total number of whole minutes in the duration.

pub fn num_seconds(&self) -> i64

Returns the total number of whole seconds in the duration.

pub fn num_milliseconds(&self) -> i64

Returns the total number of whole milliseconds in the duration,

pub fn num_microseconds(&self) -> Option<i64>

Returns the total number of whole microseconds in the duration, or None on overflow (exceeding 2⁶³ microseconds in either direction).

pub fn num_nanoseconds(&self) -> Option<i64>

Returns the total number of whole nanoseconds in the duration, or None on overflow (exceeding 2⁶³ nanoseconds in either direction).

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

Add two durations, returning None if overflow occurred.

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

Subtract two durations, returning None if overflow occurred.

pub fn min_value() -> Duration

The minimum possible Duration: i64::MIN milliseconds.

pub fn max_value() -> Duration

The maximum possible Duration: i64::MAX milliseconds.

pub fn zero() -> Duration

A duration where the stored seconds and nanoseconds are equal to zero.

pub fn is_zero(&self) -> bool

Returns true if the duration equals Duration::zero().

pub fn from_std(duration: Duration) -> Result<Duration, OutOfRangeError>

Creates a time::Duration object from std::time::Duration

This function errors when original duration is larger than the maximum value supported for this type.

pub fn to_std(&self) -> Result<Duration, OutOfRangeError>

Creates a std::time::Duration object from time::Duration

This function errors when duration is less than zero. As standard library implementation is limited to non-negative values.

Trait Implementations

impl Sub<Duration> for Duration

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Duration> for SteadyTime

type Output = SteadyTime

The resulting type after applying the - operator.

fn sub(self, other: Duration) -> SteadyTime

Performs the - operation.

impl Sub<Duration> for Tm

type Output = Tm

The resulting type after applying the - operator.

fn sub(self, other: Duration) -> Tm

The resulting Tm is in UTC.

impl Sub<Duration> for Timespec

type Output = Timespec

The resulting type after applying the - operator.

fn sub(self, other: Duration) -> Timespec

Performs the - operation.

impl PartialOrd<Duration> for Duration

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &Duration) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Duration) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &Duration) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Duration) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Mul<i32> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Duration

Performs the * operation.

impl Debug for Duration

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Copy for Duration

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 Div<i32> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> Duration

Performs the / operation.

impl Ord for Duration

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Display for Duration

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

Formats the value using the given formatter.

impl Eq for Duration

impl Add<Duration> for SteadyTime

type Output = SteadyTime

The resulting type after applying the + operator.

fn add(self, other: Duration) -> SteadyTime

Performs the + operation.

impl Add<Duration> for Tm

type Output = Tm

The resulting type after applying the + operator.

fn add(self, other: Duration) -> Tm

The resulting Tm is in UTC.

impl Add<Duration> for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Duration> for Timespec

type Output = Timespec

The resulting type after applying the + operator.

fn add(self, other: Duration) -> Timespec

Performs the + operation.

impl PartialEq<Duration> for Duration

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Duration) -> bool

This method tests for !=.

impl Neg for Duration

type Output = Duration

The resulting type after applying the - operator.

fn neg(self) -> Duration

Performs the unary - operation.

impl Add<Duration> for NaiveDate

An addition of Duration to NaiveDate discards the fractional days, rounding to the closest integral number of days towards Duration::zero().

Panics on underflow or overflow. Use NaiveDate::checked_add to detect that.

Example

use chrono::{NaiveDate, Duration};

let ymd = |y,m,d| NaiveDate::from_ymd(y, m, d);
assert_eq!(ymd(2014, 1, 1) + Duration::zero(),             ymd(2014, 1, 1));
assert_eq!(ymd(2014, 1, 1) + Duration::seconds(86399),     ymd(2014, 1, 1));
assert_eq!(ymd(2014, 1, 1) + Duration::seconds(-86399),    ymd(2014, 1, 1));
assert_eq!(ymd(2014, 1, 1) + Duration::days(1),            ymd(2014, 1, 2));
assert_eq!(ymd(2014, 1, 1) + Duration::days(-1),           ymd(2013, 12, 31));
assert_eq!(ymd(2014, 1, 1) + Duration::days(364),          ymd(2014, 12, 31));
assert_eq!(ymd(2014, 1, 1) + Duration::days(365*4 + 1),    ymd(2018, 1, 1));
assert_eq!(ymd(2014, 1, 1) + Duration::days(365*400 + 97), ymd(2414, 1, 1));

type Output = NaiveDate

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> NaiveDate

Performs the + operation.

impl Sub<Duration> for NaiveDate

A subtraction of Duration from NaiveDate discards the fractional days, rounding to the closest integral number of days towards Duration::zero().

Panics on underflow or overflow. Use NaiveDate::checked_sub to detect that.

Example

use chrono::{NaiveDate, Duration};

let ymd = |y,m,d| NaiveDate::from_ymd(y, m, d);
assert_eq!(ymd(2014, 1, 1) - Duration::zero(),             ymd(2014, 1, 1));
assert_eq!(ymd(2014, 1, 1) - Duration::seconds(86399),     ymd(2014, 1, 1));
assert_eq!(ymd(2014, 1, 1) - Duration::seconds(-86399),    ymd(2014, 1, 1));
assert_eq!(ymd(2014, 1, 1) - Duration::days(1),            ymd(2013, 12, 31));
assert_eq!(ymd(2014, 1, 1) - Duration::days(-1),           ymd(2014, 1, 2));
assert_eq!(ymd(2014, 1, 1) - Duration::days(364),          ymd(2013, 1, 2));
assert_eq!(ymd(2014, 1, 1) - Duration::days(365*4 + 1),    ymd(2010, 1, 1));
assert_eq!(ymd(2014, 1, 1) - Duration::days(365*400 + 97), ymd(1614, 1, 1));

type Output = NaiveDate

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> NaiveDate

Performs the - operation.

impl Add<Duration> for NaiveTime

type Output = NaiveTime

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> NaiveTime

Performs the + operation.

impl Sub<Duration> for NaiveTime

type Output = NaiveTime

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> NaiveTime

Performs the - operation.

impl Add<Duration> for NaiveDateTime

type Output = NaiveDateTime

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> NaiveDateTime

Performs the + operation.

impl Sub<Duration> for NaiveDateTime

type Output = NaiveDateTime

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> NaiveDateTime

Performs the - operation.

impl<Tz: TimeZone> Add<Duration> for Date<Tz>

type Output = Date<Tz>

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Date<Tz>

Performs the + operation.

impl<Tz: TimeZone> Sub<Duration> for Date<Tz>

type Output = Date<Tz>

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Date<Tz>

Performs the - operation.

impl<Tz: TimeZone> Add<Duration> for DateTime<Tz>

type Output = DateTime<Tz>

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> DateTime<Tz>

Performs the + operation.

impl<Tz: TimeZone> Sub<Duration> for DateTime<Tz>

type Output = DateTime<Tz>

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> DateTime<Tz>

Performs the - operation.