Skip to content

Fractional Time Component Representations #763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PacificBird wants to merge 1 commit into
base: main
Choose a base branch
from
+146 −0
Open

Fractional Time Component Representations #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions time/src/offset_date_time.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,25 @@ impl OffsetDateTime {
self.time().hour()
}

/// Get the fractional clock hour (i.e. 1:30 -> 1.5).
///
/// The returned value will always be in the range `0.0..24.0`.
///
/// ```rust
/// # use time_macros::{datetime, offset};
/// assert_eq!(datetime!(2019-01-01 1:30:00 UTC).fractional_hour(), 1.5);
/// assert_eq!(
/// datetime!(2019-01-01 23:30:45 UTC)
/// .to_offset(offset!(-2))
/// .fractional_hour(),
/// 21.5125,
/// );
/// ```
#[inline]
pub const fn fractional_hour(self) -> f32 {
self.time().fractional_hour()
}

/// Get the minute within the hour in the stored offset.
///
/// The returned value will always be in the range `0..60`.
Expand All @@ -903,6 +922,25 @@ impl OffsetDateTime {
self.time().minute()
}

/// Get the fractional minute within the hour (i.e. 1:30:30 -> 30.5).
///
/// The returned value will always be in the range `0.0..60.0`.
///
/// ```rust
/// # use time_macros::{datetime, offset};
/// assert_eq!(datetime!(2019-01-01 1:30:30 UTC).fractional_minute(), 30.5);
/// assert_eq!(
/// datetime!(2019-01-01 23:15:45 UTC)
/// .to_offset(offset!(+0:30))
/// .fractional_minute(),
/// 45.75,
/// );
/// ```
#[inline]
pub const fn fractional_minute(self) -> f32 {
self.time().fractional_minute()
}

/// Get the second within the minute in the stored offset.
///
/// The returned value will always be in the range `0..60`.
Expand All @@ -922,6 +960,25 @@ impl OffsetDateTime {
self.time().second()
}

/// Get the fractional second within the hour (i.e. 1:30:30 -> 30.5).
///
/// The returned value will always be in the range `0.0..60.0`.
///
/// ```rust
/// # use time_macros::{datetime, offset};
/// assert_eq!(datetime!(2019-01-01 1:00:30.550 UTC).fractional_second(), 30.55);
/// assert_eq!(
/// datetime!(2019-01-01 23:00:15.500 UTC)
/// .to_offset(offset!(+0:00:30))
/// .fractional_second(),
/// 45.5,
/// );
/// ```
#[inline]
pub const fn fractional_second(self) -> f32 {
self.time().fractional_second()
}

// Because a `UtcOffset` is limited in resolution to one second, any subsecond value will not
// change when adjusting for the offset.

Expand Down
42 changes: 42 additions & 0 deletions time/src/primitive_date_time.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,20 @@ impl PrimitiveDateTime {
self.time().hour()
}

/// Get the fractional clock hour (i.e. 1:30 -> 1.5).
///
/// The returned value will always be in the range `0.0..24.0`.
///
/// ```rust
/// # use time_macros::datetime;
/// assert_eq!(datetime!(2019-01-01 1:30:00).fractional_hour(), 1.5);
/// assert_eq!(datetime!(2019-01-01 23:00:00).fractional_hour(), 23.0);
/// ```
#[inline]
pub const fn fractional_hour(self) -> f32 {
self.time.fractional_hour()
}

/// Get the minute within the hour.
///
/// The returned value will always be in the range `0..60`.
Expand All @@ -469,6 +483,20 @@ impl PrimitiveDateTime {
self.time().minute()
}

/// Get the fractional minute within the hour (i.e. 1:30:30 -> 30.5).
///
/// The returned value will always be in the range `0.0..60.0`.
///
/// ```rust
/// # use time_macros::datetime;
/// assert_eq!(datetime!(2019-01-01 1:30:30).fractional_minute(), 30.5);
/// assert_eq!(datetime!(2019-01-01 23:00:30.600).fractional_minute(), 0.51);
/// ```
#[inline]
pub const fn fractional_minute(self) -> f32 {
self.time.fractional_minute()
}

/// Get the second within the minute.
///
/// The returned value will always be in the range `0..60`.
Expand All @@ -483,6 +511,20 @@ impl PrimitiveDateTime {
self.time().second()
}

/// Get the fractional second within the minute (i.e. 1:00:10.500 -> 10.5).
///
/// The returned value will always be in the range `0.0..60.0`.
///
/// ```rust
/// # use time_macros::datetime;
/// assert_eq!(datetime!(2019-01-01 1:00:00.500).fractional_second(), 0.5);
/// assert_eq!(datetime!(2019-01-01 23:00:30.500).fractional_second(), 30.5);
/// ```
#[inline]
pub const fn fractional_second(self) -> f32 {
self.time.fractional_second()
}

/// Get the milliseconds within the second.
///
/// The returned value will always be in the range `0..1_000`.
Expand Down
47 changes: 47 additions & 0 deletions time/src/time.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,23 @@ impl Time {
self.hour.get()
}

/// Get the fractional clock hour (i.e. 1:30 -> 1.5).
///
/// The returned value will always be in the range `0.0..24.0`.
///
/// ```rust
/// # use time_macros::time;
/// assert_eq!(time!(1:30:00).fractional_hour(), 1.5);
/// assert_eq!(time!(23:00:00).fractional_hour(), 23.0);
/// ```
#[inline]
pub const fn fractional_hour(self) -> f32 {
self.hour.get() as f32
+ (self.minute.get() as f32 / 60.0)
+ (self.second.get() as f32 / (60.0 * 60.0))
+ (self.nanosecond.get() as f32 / (60.0 * 60.0 * 1.0e9))
}

/// Get the minute within the hour.
///
/// The returned value will always be in the range `0..60`.
Expand All @@ -398,6 +415,22 @@ impl Time {
self.minute.get()
}

/// Get the fractional minute within the hour (i.e. 1:30:30 -> 30.5).
///
/// The returned value will always be in the range `0.0..60.0`.
///
/// ```rust
/// # use time_macros::time;
/// assert_eq!(time!(1:30:30).fractional_minute(), 30.5);
/// assert_eq!(time!(23:00:30.600).fractional_minute(), 0.51);
/// ```
#[inline]
pub const fn fractional_minute(self) -> f32 {
self.minute.get() as f32
+ (self.second.get() as f32 / (60.0))
+ (self.nanosecond.get() as f32 / (60.0 * 1.0e9))
}

/// Get the second within the minute.
///
/// The returned value will always be in the range `0..60`.
Expand All @@ -412,6 +445,20 @@ impl Time {
self.second.get()
}

/// Get the fractional second within the minute (i.e. 1:00:10.500 -> 10.5).
///
/// The returned value will always be in the range `0.0..60.0`.
///
/// ```rust
/// # use time_macros::time;
/// assert_eq!(time!(1:00:00.500).fractional_second(), 0.5);
/// assert_eq!(time!(23:00:30.500).fractional_second(), 30.5);
/// ```
#[inline]
pub const fn fractional_second(self) -> f32 {
self.second.get() as f32 + (self.nanosecond.get() as f32 / 1.0e9)
}

/// Get the milliseconds within the second.
///
/// The returned value will always be in the range `0..1_000`.
Expand Down
Loading