Struct TimeDelta 

pub struct TimeDelta { /* private fields */ }

Time duration with nanosecond precision.

This also allows for negative durations; see individual methods for details.

A TimeDelta is represented internally as a complement of seconds and nanoseconds. The range is restricted to that of i64 milliseconds, with the minimum value notably being set to -i64::MAX rather than allowing the full range of i64::MIN. This is to allow easy flipping of sign, so that for instance abs() can be called without any checks.

Implementations

impl TimeDelta

pub const MIN: TimeDelta = MIN

The minimum possible TimeDelta: -i64::MAX milliseconds.

pub const MAX: TimeDelta = MAX

The maximum possible TimeDelta: i64::MAX milliseconds.

pub const fn new(secs: i64, nanos: u32) -> Option<TimeDelta>

Makes a new TimeDelta with given number of seconds and nanoseconds.

Errors

Returns None when the duration is out of bounds, or if nanos ≥ 1,000,000,000.

pub const fn weeks(weeks: i64) -> TimeDelta

Makes a new TimeDelta with the given number of weeks.

Equivalent to TimeDelta::seconds(weeks * 7 * 24 * 60 * 60) with overflow checks.

Panics

Panics when the duration is out of bounds.

pub const fn try_weeks(weeks: i64) -> Option<TimeDelta>

Makes a new TimeDelta with the given number of weeks.

Equivalent to TimeDelta::try_seconds(weeks * 7 * 24 * 60 * 60) with overflow checks.

Errors

Returns None when the TimeDelta would be out of bounds.

pub const fn days(days: i64) -> TimeDelta

Makes a new TimeDelta with the given number of days.

Equivalent to TimeDelta::seconds(days * 24 * 60 * 60) with overflow checks.

Panics

Panics when the TimeDelta would be out of bounds.

pub const fn try_days(days: i64) -> Option<TimeDelta>

Makes a new TimeDelta with the given number of days.

Equivalent to TimeDelta::try_seconds(days * 24 * 60 * 60) with overflow checks.

Errors

Returns None when the TimeDelta would be out of bounds.

pub const fn hours(hours: i64) -> TimeDelta

Makes a new TimeDelta with the given number of hours.

Equivalent to TimeDelta::seconds(hours * 60 * 60) with overflow checks.

Panics

Panics when the TimeDelta would be out of bounds.

pub const fn try_hours(hours: i64) -> Option<TimeDelta>

Makes a new TimeDelta with the given number of hours.

Equivalent to TimeDelta::try_seconds(hours * 60 * 60) with overflow checks.

Errors

Returns None when the TimeDelta would be out of bounds.

pub const fn minutes(minutes: i64) -> TimeDelta

Makes a new TimeDelta with the given number of minutes.

Equivalent to TimeDelta::seconds(minutes * 60) with overflow checks.

Panics

Panics when the TimeDelta would be out of bounds.

pub const fn try_minutes(minutes: i64) -> Option<TimeDelta>

Makes a new TimeDelta with the given number of minutes.

Equivalent to TimeDelta::try_seconds(minutes * 60) with overflow checks.

Errors

Returns None when the TimeDelta would be out of bounds.

pub const fn seconds(seconds: i64) -> TimeDelta

Makes a new TimeDelta with the given number of seconds.

Panics

Panics when seconds is more than i64::MAX / 1_000 or less than -i64::MAX / 1_000 (in this context, this is the same as i64::MIN / 1_000 due to rounding).

pub const fn try_seconds(seconds: i64) -> Option<TimeDelta>

Makes a new TimeDelta with the given number of seconds.

Errors

Returns None when seconds is more than i64::MAX / 1_000 or less than -i64::MAX / 1_000 (in this context, this is the same as i64::MIN / 1_000 due to rounding).

pub const fn milliseconds(milliseconds: i64) -> TimeDelta

Makes a new TimeDelta with the given number of milliseconds.

Panics

Panics when the TimeDelta would be out of bounds, i.e. when milliseconds is more than i64::MAX or less than -i64::MAX. Notably, this is not the same as i64::MIN.

pub const fn try_milliseconds(milliseconds: i64) -> Option<TimeDelta>

Makes a new TimeDelta with the given number of milliseconds.

Errors

Returns None the TimeDelta would be out of bounds, i.e. when milliseconds is more than i64::MAX or less than -i64::MAX. Notably, this is not the same as i64::MIN.

pub const fn microseconds(microseconds: i64) -> TimeDelta

Makes a new TimeDelta with the given number of microseconds.

The number of microseconds acceptable by this constructor is less than the total number that can actually be stored in a TimeDelta, so it is not possible to specify a value that would be out of bounds. This function is therefore infallible.

pub const fn nanoseconds(nanos: i64) -> TimeDelta

Makes a new TimeDelta with the given number of nanoseconds.

The number of nanoseconds acceptable by this constructor is less than the total number that can actually be stored in a TimeDelta, so it is not possible to specify a value that would be out of bounds. This function is therefore infallible.

pub const fn num_weeks(&self) -> i64

Returns the total number of whole weeks in the TimeDelta.

pub const fn num_days(&self) -> i64

Returns the total number of whole days in the TimeDelta.

pub const fn num_hours(&self) -> i64

Returns the total number of whole hours in the TimeDelta.

pub const fn num_minutes(&self) -> i64

Returns the total number of whole minutes in the TimeDelta.

pub const fn num_seconds(&self) -> i64

Returns the total number of whole seconds in the TimeDelta.

pub fn as_seconds_f64(self) -> f64

Returns the fractional number of seconds in the TimeDelta.

pub fn as_seconds_f32(self) -> f32

Returns the fractional number of seconds in the TimeDelta.

pub const fn num_milliseconds(&self) -> i64

Returns the total number of whole milliseconds in the TimeDelta.

pub const fn subsec_millis(&self) -> i32

Returns the number of milliseconds in the fractional part of the duration.

This is the number of milliseconds such that subsec_millis() + num_seconds() * 1_000 is the truncated number of milliseconds in the duration.

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

Returns the total number of whole microseconds in the TimeDelta, or None on overflow (exceeding 2^63 microseconds in either direction).

pub const fn subsec_micros(&self) -> i32

Returns the number of microseconds in the fractional part of the duration.

This is the number of microseconds such that subsec_micros() + num_seconds() * 1_000_000 is the truncated number of microseconds in the duration.

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

Returns the total number of whole nanoseconds in the TimeDelta, or None on overflow (exceeding 2^63 nanoseconds in either direction).

pub const fn subsec_nanos(&self) -> i32

Returns the number of nanoseconds in the fractional part of the duration.

This is the number of nanoseconds such that subsec_nanos() + num_seconds() * 1_000_000_000 is the total number of nanoseconds in the TimeDelta.

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

Add two TimeDeltas, returning None if overflow occurred.

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

Subtract two TimeDeltas, returning None if overflow occurred.

pub const fn checked_mul(&self, rhs: i32) -> Option<TimeDelta>

Multiply a TimeDelta with a i32, returning None if overflow occurred.

pub const fn checked_div(&self, rhs: i32) -> Option<TimeDelta>

Divide a TimeDelta with a i32, returning None if dividing by 0.

pub const fn abs(&self) -> TimeDelta

Returns the TimeDelta as an absolute (non-negative) value.

pub const fn min_value() -> TimeDelta

👎Deprecated since 0.4.39: Use TimeDelta::MIN instead

The minimum possible TimeDelta: -i64::MAX milliseconds.

pub const fn max_value() -> TimeDelta

👎Deprecated since 0.4.39: Use TimeDelta::MAX instead

The maximum possible TimeDelta: i64::MAX milliseconds.

pub const fn zero() -> TimeDelta

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

pub const fn is_zero(&self) -> bool

Returns true if the TimeDelta equals TimeDelta::zero().

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

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

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

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

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

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

Trait Implementations

impl<Tz> Add<TimeDelta> for DateTime<Tz>

where Tz: TimeZone,

Add TimeDelta to DateTime.

As a part of Chrono’s [leap second handling], the addition assumes that there is no leap second ever, except when the NaiveDateTime itself represents a leap second in which case the assumption becomes that there is exactly a single leap second ever.

Panics

Panics if the resulting date would be out of range. Consider using DateTime<Tz>::checked_add_signed to get an Option instead.

type Output = DateTime<Tz>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for TimeDelta

type Output = TimeDelta

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Tz> AddAssign<TimeDelta> for DateTime<Tz>

where Tz: TimeZone,

Add-assign chrono::Duration to DateTime.

As a part of Chrono’s [leap second handling], the addition assumes that there is no leap second ever, except when the NaiveDateTime itself represents a leap second in which case the assumption becomes that there is exactly a single leap second ever.

Panics

Panics if the resulting date would be out of range. Consider using DateTime<Tz>::checked_add_signed to get an Option instead.

fn add_assign(&mut self, rhs: TimeDelta)

Performs the += operation.

impl AddAssign for TimeDelta

fn add_assign(&mut self, rhs: TimeDelta)

Performs the += operation.

impl Clone for TimeDelta

fn clone(&self) -> TimeDelta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeDelta

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

Formats the value using the given formatter.

impl Default for TimeDelta

fn default() -> TimeDelta

Returns the “default value” for a type.

impl Display for TimeDelta

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

Format a TimeDelta using the ISO 8601 format

impl Div<i32> for TimeDelta

type Output = TimeDelta

The resulting type after applying the / operator.

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

Performs the / operation.

impl Hash for TimeDelta

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

where __H: Hasher,

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 Mul<i32> for TimeDelta

type Output = TimeDelta

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for TimeDelta

type Output = TimeDelta

The resulting type after applying the - operator.

fn neg(self) -> TimeDelta

Performs the unary - operation.

impl Ord for TimeDelta

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

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

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

where Tz: TimeZone,

Subtract TimeDelta from DateTime.

This is the same as the addition with a negated TimeDelta.

As a part of Chrono’s [leap second handling] the subtraction assumes that there is no leap second ever, except when the DateTime itself represents a leap second in which case the assumption becomes that there is exactly a single leap second ever.

Panics

Panics if the resulting date would be out of range. Consider using DateTime<Tz>::checked_sub_signed to get an Option instead.

type Output = DateTime<Tz>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for TimeDelta

type Output = TimeDelta

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Tz> SubAssign<TimeDelta> for DateTime<Tz>

where Tz: TimeZone,

Subtract-assign TimeDelta from DateTime.

This is the same as the addition with a negated TimeDelta.

As a part of Chrono’s [leap second handling], the addition assumes that there is no leap second ever, except when the DateTime itself represents a leap second in which case the assumption becomes that there is exactly a single leap second ever.

Panics

Panics if the resulting date would be out of range. Consider using DateTime<Tz>::checked_sub_signed to get an Option instead.

fn sub_assign(&mut self, rhs: TimeDelta)

Performs the -= operation.

impl SubAssign for TimeDelta

fn sub_assign(&mut self, rhs: TimeDelta)

Performs the -= operation.

impl<'a> Sum<&'a TimeDelta> for TimeDelta

fn sum<I>(iter: I) -> TimeDelta

where I: Iterator<Item = &'a TimeDelta>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for TimeDelta

fn sum<I>(iter: I) -> TimeDelta

where I: Iterator<Item = TimeDelta>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for TimeDelta

impl Eq for TimeDelta

impl StructuralPartialEq for TimeDelta