time 0.3.0-alpha-0

#![allow(trivial_numeric_casts, clippy::use_self)]

use core::time::Duration as StdDuration;

use crate::Duration;

// region: NumericalDuration
/// Create [`Duration`]s from primitive and core numeric types.
///
/// Due to limitations in rustc, these methods are currently _not_ `const fn`. See
/// [RFC 2632](https://github.com/rust-lang/rfcs/pull/2632) for details.
///
/// # Examples
///
/// Basic construction of [`Duration`]s.
///
/// ```rust
/// # use time::{Duration, ext::NumericalDuration};
/// assert_eq!(5.nanoseconds(), Duration::nanoseconds(5));
/// assert_eq!(5.microseconds(), Duration::microseconds(5));
/// assert_eq!(5.milliseconds(), Duration::milliseconds(5));
/// assert_eq!(5.seconds(), Duration::seconds(5));
/// assert_eq!(5.minutes(), Duration::minutes(5));
/// assert_eq!(5.hours(), Duration::hours(5));
/// assert_eq!(5.days(), Duration::days(5));
/// assert_eq!(5.weeks(), Duration::weeks(5));
/// ```
///
/// Signed integers work as well!
///
/// ```rust
/// # use time::{Duration, ext::NumericalDuration};
/// assert_eq!((-5).nanoseconds(), Duration::nanoseconds(-5));
/// assert_eq!((-5).microseconds(), Duration::microseconds(-5));
/// assert_eq!((-5).milliseconds(), Duration::milliseconds(-5));
/// assert_eq!((-5).seconds(), Duration::seconds(-5));
/// assert_eq!((-5).minutes(), Duration::minutes(-5));
/// assert_eq!((-5).hours(), Duration::hours(-5));
/// assert_eq!((-5).days(), Duration::days(-5));
/// assert_eq!((-5).weeks(), Duration::weeks(-5));
/// ```
///
/// Just like any other [`Duration`], they can be added, subtracted, etc.
///
/// ```rust
/// # use time::ext::NumericalDuration;
/// assert_eq!(2.seconds() + 500.milliseconds(), 2_500.milliseconds());
/// assert_eq!(2.seconds() - 500.milliseconds(), 1_500.milliseconds());
/// ```
///
/// When called on floating point values, any remainder of the floating point value will be
/// truncated. Keep in mind that floating point numbers are inherently imprecise and have limited
/// capacity.
pub trait NumericalDuration {
    /// Create a [`Duration`] from the number of nanoseconds.
    fn nanoseconds(self) -> Duration;
    /// Create a [`Duration`] from the number of microseconds.
    fn microseconds(self) -> Duration;
    /// Create a [`Duration`] from the number of milliseconds.
    fn milliseconds(self) -> Duration;
    /// Create a [`Duration`] from the number of seconds.
    fn seconds(self) -> Duration;
    /// Create a [`Duration`] from the number of minutes.
    fn minutes(self) -> Duration;
    /// Create a [`Duration`] from the number of hours.
    fn hours(self) -> Duration;
    /// Create a [`Duration`] from the number of days.
    fn days(self) -> Duration;
    /// Create a [`Duration`] from the number of weeks.
    fn weeks(self) -> Duration;
}

macro_rules! impl_numerical_duration {
    ($($type:ty),+ $(,)?) => {$(
        impl NumericalDuration for $type {
            fn nanoseconds(self) -> Duration {
                Duration::nanoseconds(self as _)
            }

            fn microseconds(self) -> Duration {
                Duration::microseconds(self as _)
            }

            fn milliseconds(self) -> Duration {
                Duration::milliseconds(self as _)
            }

            fn seconds(self) -> Duration {
                Duration::seconds(self as _)
            }

            fn minutes(self) -> Duration {
                Duration::minutes(self as _)
            }

            fn hours(self) -> Duration {
                Duration::hours(self as _)
            }

            fn days(self) -> Duration {
                Duration::days(self as _)
            }

            fn weeks(self) -> Duration {
                Duration::weeks(self as _)
            }
        }
    )+};
}

macro_rules! impl_numerical_duration_nonzero {
    ($($type:ty),+ $(,)?) => {$(
        impl NumericalDuration for $type {
            fn nanoseconds(self) -> Duration {
                Duration::nanoseconds(self.get() as _)
            }

            fn microseconds(self) -> Duration {
                Duration::microseconds(self.get() as _)
            }

            fn milliseconds(self) -> Duration {
                Duration::milliseconds(self.get() as _)
            }

            fn seconds(self) -> Duration {
                Duration::seconds(self.get() as _)
            }

            fn minutes(self) -> Duration {
                Duration::minutes(self.get() as _)
            }

            fn hours(self) -> Duration {
                Duration::hours(self.get() as _)
            }

            fn days(self) -> Duration {
                Duration::days(self.get() as _)
            }

            fn weeks(self) -> Duration {
                Duration::weeks(self.get() as _)
            }
        }
    )+};
}

macro_rules! impl_numerical_duration_float {
    ($($type:ty),+ $(,)?) => {$(
        impl NumericalDuration for $type {
            fn nanoseconds(self) -> Duration {
                Duration::nanoseconds(self as _)
            }

            fn microseconds(self) -> Duration {
                Duration::nanoseconds((self * 1_000.) as _)
            }

            fn milliseconds(self) -> Duration {
                Duration::nanoseconds((self * 1_000_000.) as _)
            }

            fn seconds(self) -> Duration {
                Duration::nanoseconds((self * 1_000_000_000.) as _)
            }

            fn minutes(self) -> Duration {
                Duration::nanoseconds((self * 60_000_000_000.) as _)
            }

            fn hours(self) -> Duration {
                Duration::nanoseconds((self * 3_600_000_000_000.) as _)
            }

            fn days(self) -> Duration {
                Duration::nanoseconds((self * 86_400_000_000_000.) as _)
            }

            fn weeks(self) -> Duration {
                Duration::nanoseconds((self * 604_800_000_000_000.) as _)
            }
        }
    )+};
}

impl_numerical_duration![u8, u16, u32, i8, i16, i32, i64];
impl_numerical_duration_nonzero![
    core::num::NonZeroU8,
    core::num::NonZeroU16,
    core::num::NonZeroU32,
    core::num::NonZeroI8,
    core::num::NonZeroI16,
    core::num::NonZeroI32,
    core::num::NonZeroI64,
];
impl_numerical_duration_float![f32, f64];
// endregion NumericalDuration

// region: NumericalStdDuration
/// Create [`std::time::Duration`]s from primitive and core numeric types.
///
/// Due to limitations in rustc, these methods are currently _not_ `const fn`. See
/// [RFC 2632](https://github.com/rust-lang/rfcs/pull/2632) for details.
///
/// # Examples
///
/// Basic construction of [`std::time::Duration`]s.
///
/// ```rust
/// # use time::ext::NumericalStdDuration;
/// # use core::time::Duration;
/// assert_eq!(5.std_nanoseconds(), Duration::from_nanos(5));
/// assert_eq!(5.std_microseconds(), Duration::from_micros(5));
/// assert_eq!(5.std_milliseconds(), Duration::from_millis(5));
/// assert_eq!(5.std_seconds(), Duration::from_secs(5));
/// assert_eq!(5.std_minutes(), Duration::from_secs(5 * 60));
/// assert_eq!(5.std_hours(), Duration::from_secs(5 * 3_600));
/// assert_eq!(5.std_days(), Duration::from_secs(5 * 86_400));
/// assert_eq!(5.std_weeks(), Duration::from_secs(5 * 604_800));
/// ```
///
/// Just like any other [`std::time::Duration`], they can be added, subtracted, etc.
///
/// ```rust
/// # use time::ext::NumericalStdDuration;
/// assert_eq!(
///     2.std_seconds() + 500.std_milliseconds(),
///     2_500.std_milliseconds()
/// );
/// assert_eq!(
///     2.std_seconds() - 500.std_milliseconds(),
///     1_500.std_milliseconds()
/// );
/// ```
///
/// When called on floating point values, any remainder of the floating point value will be
/// truncated. Keep in mind that floating point numbers are inherently imprecise and have limited
/// capacity.
pub trait NumericalStdDuration {
    /// Create a [`std::time::Duration`] from the number of nanoseconds.
    fn std_nanoseconds(self) -> StdDuration;
    /// Create a [`std::time::Duration`] from the number of microseconds.
    fn std_microseconds(self) -> StdDuration;
    /// Create a [`std::time::Duration`] from the number of milliseconds.
    fn std_milliseconds(self) -> StdDuration;
    /// Create a [`std::time::Duration`] from the number of seconds.
    fn std_seconds(self) -> StdDuration;
    /// Create a [`std::time::Duration`] from the number of minutes.
    fn std_minutes(self) -> StdDuration;
    /// Create a [`std::time::Duration`] from the number of hours.
    fn std_hours(self) -> StdDuration;
    /// Create a [`std::time::Duration`] from the number of days.
    fn std_days(self) -> StdDuration;
    /// Create a [`std::time::Duration`] from the number of weeks.
    fn std_weeks(self) -> StdDuration;
}

macro_rules! impl_numerical_std_duration {
    ($($type:ty),+ $(,)?) => {$(
        impl NumericalStdDuration for $type {
            fn std_nanoseconds(self) -> StdDuration {
                StdDuration::from_nanos(self as _)
            }

            fn std_microseconds(self) -> StdDuration {
                StdDuration::from_micros(self as _)
            }

            fn std_milliseconds(self) -> StdDuration {
                StdDuration::from_millis(self as _)
            }

            fn std_seconds(self) -> StdDuration {
                StdDuration::from_secs(self as _)
            }

            fn std_minutes(self) -> StdDuration {
                StdDuration::from_secs(self as u64 * 60)
            }

            fn std_hours(self) -> StdDuration {
                StdDuration::from_secs(self as u64 * 3_600)
            }

            fn std_days(self) -> StdDuration {
                StdDuration::from_secs(self as u64 * 86_400)
            }

            fn std_weeks(self) -> StdDuration {
                StdDuration::from_secs(self as u64 * 604_800)
            }
        }
    )+};
}

macro_rules! impl_numerical_std_duration_nonzero {
    ($($type:ty),+ $(,)?) => {$(
        impl NumericalStdDuration for $type {
            fn std_nanoseconds(self) -> StdDuration {
                StdDuration::from_nanos(self.get() as _)
            }

            fn std_microseconds(self) -> StdDuration {
                StdDuration::from_micros(self.get() as _)
            }

            fn std_milliseconds(self) -> StdDuration {
                StdDuration::from_millis(self.get() as _)
            }

            fn std_seconds(self) -> StdDuration {
                StdDuration::from_secs(self.get() as _)
            }

            fn std_minutes(self) -> StdDuration {
                StdDuration::from_secs(self.get() as u64 * 60)
            }

            fn std_hours(self) -> StdDuration {
                StdDuration::from_secs(self.get() as u64 * 3_600)
            }

            fn std_days(self) -> StdDuration {
                StdDuration::from_secs(self.get() as u64 * 86_400)
            }

            fn std_weeks(self) -> StdDuration {
                StdDuration::from_secs(self.get() as u64 * 604_800)
            }
        }
    )+};
}

impl_numerical_std_duration![u8, u16, u32, u64];
impl_numerical_std_duration_nonzero![
    core::num::NonZeroU8,
    core::num::NonZeroU16,
    core::num::NonZeroU32,
    core::num::NonZeroU64,
];

/// Implement on `i32` because that's the default type for integers. This performs a runtime check
/// and panics if the value is negative.
impl NumericalStdDuration for i32 {
    fn std_nanoseconds(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_nanos(self as _)
    }

    fn std_microseconds(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_micros(self as _)
    }

    fn std_milliseconds(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_millis(self as _)
    }

    fn std_seconds(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_secs(self as _)
    }

    fn std_minutes(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_secs(self as u64 * 60)
    }

    fn std_hours(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_secs(self as u64 * 3_600)
    }

    fn std_days(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_secs(self as u64 * 86_400)
    }

    fn std_weeks(self) -> StdDuration {
        assert!(self >= 0);
        StdDuration::from_secs(self as u64 * 604_800)
    }
}

/// Implement on `f64` because that's the default type for floats. This performs a runtime check and
/// panics if the value is negative.
impl NumericalStdDuration for f64 {
    fn std_nanoseconds(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos(self as _)
    }

    fn std_microseconds(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos((self * 1_000.) as _)
    }

    fn std_milliseconds(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos((self * 1_000_000.) as _)
    }

    fn std_seconds(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos((self * 1_000_000_000.) as _)
    }

    fn std_minutes(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos((self * 60_000_000_000.) as _)
    }

    fn std_hours(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos((self * 3_600_000_000_000.) as _)
    }

    fn std_days(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos((self * 86_400_000_000_000.) as _)
    }

    fn std_weeks(self) -> StdDuration {
        assert!(self >= 0.);
        StdDuration::from_nanos((self * 604_800_000_000_000.) as _)
    }
}
// endregion NumericalStdDuration