Struct Duration 

pub struct Duration { /* private fields */ }

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

Implementations

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.

Examples found in repository

examples/tour.rs (line 21)

fn main() {
    let good_communism = "2023-02-08T12:00:00-07:00";
    let bad_communism = "Comrade, today is the eighth of Februrary, in the year 2023.";
    let pre_history = "1775-07-04";

    let liberated = FreedomDate::liberate(good_communism).unwrap();
    let too_communist = FreedomDate::liberate(bad_communism).unwrap_err();
    let pre_historic_nonsense = FreedomDate::liberate(pre_history).unwrap_err();

    println!("'{good_communism}' is liberated: `{liberated}`\n");
    println!("'{bad_communism}' is impossible to comprehend: `{too_communist}`\n");
    println!("'{pre_history}' is not a real date: `{pre_historic_nonsense}`\n");

    // `From<u64>` is implemented for FreedomDates
    let birthday_of_freedom: FreedomDate = 0.into();
    println!("The Birthday of Freedom is {birthday_of_freedom}\n");

    // FreedomDates implement the FreedomTime trait
    let one_day = Duration::days(1);
    let day_after_freedom = birthday_of_freedom + one_day;
    println!(
        "The day after Freedom was born, {day_after_freedom}, {} seconds had passed.",
        day_after_freedom.freedomstamp()
    );
}

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<Tz> Add<Duration> for DateTime<Tz>

where Tz: TimeZone,

type Output = DateTime<Tz>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Duration> for FreedomDate

type Output = FreedomDate

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Tz> AddAssign<Duration> for DateTime<Tz>

where Tz: TimeZone,

fn add_assign(&mut self, rhs: Duration)

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<(), Error>

Formats the value using the given formatter.

impl Display for Duration

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

Formats the value using the given formatter.

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

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 Duration

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Duration

type Output = Duration

The resulting type after applying the - operator.

fn neg(self) -> Duration

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<Tz> Sub<Duration> for DateTime<Tz>

where Tz: TimeZone,

type Output = DateTime<Tz>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Duration> for FreedomDate

type Output = Result<FreedomDate, FreedomError>

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: Duration) -> Duration

Performs the - operation.

impl<Tz> SubAssign<Duration> for DateTime<Tz>

where Tz: TimeZone,

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration