Skip to content
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

Jump to bottom

NaiveDateTime::from_timestamp_millis(_opt) #818

Merged
merged 5 commits into from Sep 19, 2022
Merged

NaiveDateTime::from_timestamp_millis(_opt) #818

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
341ed5a
NaiveDateTime::from_timestamp_millis(_opt)
Pscheidl Sep 11, 2022
80885d8
docs: Simplify documentation for NaiveDateTime::from_timestamp_millis
Pscheidl Sep 12, 2022
63b26bb
docs: prefix UNIX with `the`, remove whitespaces
Pscheidl Sep 12, 2022
b175f9c
fix: Negative UNIX timestamps accepted by `from_timestamp_millis`
Pscheidl Sep 14, 2022
de12842
refactor: Use checked substitution & convert u32 conversiont to None …
Pscheidl Sep 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/naive/datetime/mod.rs
View file
Open in desktop
Expand Up @@ -127,6 +127,28 @@ impl NaiveDateTime {
datetime.expect("invalid or out-of-range datetime")
}

/// Makes a new `NaiveDateTime` corresponding to a UTC date and time,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You probably copy-pasted this from one of the other methods, but we're trying to make the first line of docstrings self-contained sentence fragments. After that we should have an empty line, then a more detailed description. Would you mind tweaking the docs for this new method at least?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the whole doc can be simplified. Gave it a try. Please have a look.

/// from the number of milliseconds
/// since the midnight UTC on January 1, 1970 (aka "UNIX timestamp").
///
/// Returns `None` on the out-of-range number of milliseconds and/or invalid nanosecond.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, there's no "invalid nanosecond", right? Also I think "the" -> "an" would read better?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, there are no invalid nanos in this case. Changed.

///
/// # Example
///
/// ```
/// use chrono::NaiveDateTime;
/// let timestamp_millis: i64 = 1662921288; //Sunday, September 11, 2022 6:34:48 PM
/// let naive_datetime = NaiveDateTime::from_timestamp_millis(timestamp_millis);
/// assert!(naive_datetime.is_some());
/// assert_eq!(timestamp_millis, naive_datetime.unwrap().timestamp_millis());
/// ```
#[inline]
pub fn from_timestamp_millis(millis: i64) -> Option<NaiveDateTime> {
let secs = millis / 1000;
let nsecs = (millis % 1000) as u32 * 1_000_000;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks problematic as the input millis could be negative, and will still be negative after taking the modulo (playground)

One option would be to have two cases, depending on whether millis is positive or negative, similar to the logic used here

The other option is just:
NaiveDate::from_ymd(1970,1, 1).and_hms(0, 0, 0) + TimeDelta::from_millis(millis)

Also it would be preferable to use TryFrom instead of as

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, let's deal with that. I'm super busy ATM, please give me by the end of the week :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should go through TimeDelta here, which adds a bunch of overhead and feels like a layering violation. Would be better to do a minimal calculation and still defer to NaiveDateTime::from_timestamp_opt().

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call RE. avoiding TimeDelta especially as from_millis may well get deprecated anyway

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. The nanos calculation is split, as when the timestamp in millis is negative, an additional abs() op is done.

NaiveDateTime::from_timestamp_opt(secs, nsecs)
}

/// Makes a new `NaiveDateTime` corresponding to a UTC date and time,
/// from the number of non-leap seconds
/// since the midnight UTC on January 1, 1970 (aka "UNIX timestamp")
Expand Down