Add functions `Duration::try_from_secs_{f32, f64}` #82179

mbartlett21 · 2021-02-16T11:32:23Z

These functions allow constructing a Duration from a floating point value that could be out of range without panicking.

Tracking issue: #83400

rust-highfive · 2021-02-16T11:32:25Z

(rust-highfive has picked a reviewer for you, use r? to override)

marmeladema · 2021-02-16T12:22:27Z

Just a random contributor opinon here^^.
If the try_ prefix is usually associated with a Result return type then maybe checked_from_secs would work with an Option return type? I feel like if there are different reasons for the failure (or if we suspect their will be in the future), then a Result return type and a proper error being returned is nicer but if it's just a blind failure then a Option is fine.

jieyouxu · 2021-02-16T15:34:35Z

Maybe it would make sense then to have both checked_from_secs_{f32,f64} -> Option<Duration> and try_from_secs_{f32,f64} -> Result<Duration, DurationConversionError> (the checked variant for wishing to handle fallible conversion but don't care for the cause, the try variant for wishing to handle fallible conversion and to know the cause of the conversion failure)? Where DurationConversionError is something like

enum DurationConversionError {
    NotFinite, // note: maybe distinguish between Inf/-Inf and NaN floating point values?
    Negative,
    Overflow
}

marmeladema · 2021-02-16T16:00:28Z

Well, if we do want a get the actual error and if the error is not especially costly to compute, which is most likely going to be the case, I don't really see the benefit of having another version that returns an Option.
A user of that API can choose to ignore the error, call .ok() to turn into an Option or whatever.

mbartlett21 · 2021-02-17T06:57:02Z

Should I open a tracking issue where this can be discussed?

I would rather have an opaque error type that just displays different messages for different errors, only using an enum internally. (See ParseIntError for an example)

Dylan-DPC-zz · 2021-03-23T01:10:13Z

@mbartlett21

Should I open a tracking issue where this can be discussed?

yes it is better to do that.

mbartlett21 · 2021-03-23T01:55:25Z

The tracking issue is #83400

library/core/src/time.rs

mbartlett21 · 2021-04-22T12:59:35Z

@rustbot modify labels +S-waiting-on-review -S-waiting-on-author

JohnTitor · 2021-06-14T07:26:14Z

r? @joshtriplett
and @mbartlett21 it'd be great if you could squash commits, the current is a bit long to read.

This also adds the error type used, `FromSecsError` and its `impl`s.

`Duration::from_secs_{f32, f64}` now use the results from the non-panicking functions and unwrap it.

mbartlett21 · 2021-06-14T12:21:23Z

@JohnTitor I have made it into two commits now, one adding the new functions, and the other changing from_secs_{f32, f64} to use the new functions.

library/core/src/time.rs

joshtriplett · 2021-06-14T20:36:21Z

Posted one comment; LGTM otherwise. r=me with that fixed.

joshtriplett · 2021-06-15T06:50:31Z

@bors r+

JohnTitor · 2021-06-15T07:08:36Z

@bors r=joshtriplett

bors · 2021-06-15T07:08:38Z

📌 Commit 7803955 has been approved by joshtriplett

Rollup of 10 pull requests Successful merges: - rust-lang#80269 (Explain non-dropped sender recv in docs) - rust-lang#82179 (Add functions `Duration::try_from_secs_{f32, f64}`) - rust-lang#85608 (Stabilize `ops::ControlFlow` (just the type)) - rust-lang#85792 (Refactor windows sockets impl methods) - rust-lang#86220 (Improve maybe_uninit_extra docs) - rust-lang#86277 (Remove must_use from ALLOWED_ATTRIBUTES) - rust-lang#86285 (:arrow_up: rust-analyzer) - rust-lang#86294 (Stabilize {std, core}::prelude::rust_*.) - rust-lang#86306 (Add mailmap entries for myself) - rust-lang#86314 (Remove trailing triple backticks in `mut_keyword` docs) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

bors · 2021-06-15T22:56:30Z

⌛ Testing commit 7803955 with merge 607d6b0...

…on-try-from-secs-float, r=dtolnay Stabilize `duration_checked_float` ## Stabilization Report This stabilization report is for a stabilization of `duration_checked_float`, tracking issue: rust-lang#83400. ### Implementation History - rust-lang#82179 - rust-lang#90247 - rust-lang#96051 - Changed error type to `FromFloatSecsError` in rust-lang#90247 - rust-lang#96051 changes the rounding mode to round-to-nearest instead of truncate. ## API Summary This stabilization report proposes the following API to be stabilized in `core`, along with their re-exports in `std`: ```rust // core::time impl Duration { pub const fn try_from_secs_f32(secs: f32) -> Result<Duration, TryFromFloatSecsError>; pub const fn try_from_secs_f64(secs: f64) -> Result<Duration, TryFromFloatSecsError>; } #[derive(Debug, Clone, PartialEq, Eq)] pub struct TryFromFloatSecsError { ... } impl core::fmt::Display for TryFromFloatSecsError { ... } impl core::error::Error for TryFromFloatSecsError { ... } ``` These functions are made const unstable under `duration_consts_float`, tracking issue rust-lang#72440. There is an open question in the tracking issue around what the error type should be called which I was hoping to resolve in the context of an FCP. In this stabilization PR, I have altered the name of the error type to `TryFromFloatSecsError`. In my opinion, the error type shares the name of the method (adjusted to accommodate both types of floats), which is consistent with other error types in `core`, `alloc` and `std` like `TryReserveError` and `TryFromIntError`. ## Experience Report Code such as this is ready to be converted to a checked API to ensure it is panic free: ```rust impl Time { pub fn checked_add_f64(&self, seconds: f64) -> Result<Self, TimeError> { // Fail safely during `f64` conversion to duration if seconds.is_nan() || seconds.is_infinite() { return Err(TzOutOfRangeError::new().into()); } if seconds.is_sign_positive() { self.checked_add(Duration::from_secs_f64(seconds)) } else { self.checked_sub(Duration::from_secs_f64(-seconds)) } } } ``` See: artichoke/artichoke#2194. `@rustbot` label +T-libs-api -T-libs cc `@mbartlett21`

…on-try-from-secs-float, r=dtolnay Stabilize `duration_checked_float` ## Stabilization Report This stabilization report is for a stabilization of `duration_checked_float`, tracking issue: rust-lang#83400. ### Implementation History - rust-lang#82179 - rust-lang#90247 - rust-lang#96051 - Changed error type to `FromFloatSecsError` in rust-lang#90247 - rust-lang#96051 changes the rounding mode to round-to-nearest instead of truncate. ## API Summary This stabilization report proposes the following API to be stabilized in `core`, along with their re-exports in `std`: ```rust // core::time impl Duration { pub const fn try_from_secs_f32(secs: f32) -> Result<Duration, TryFromFloatSecsError>; pub const fn try_from_secs_f64(secs: f64) -> Result<Duration, TryFromFloatSecsError>; } #[derive(Debug, Clone, PartialEq, Eq)] pub struct TryFromFloatSecsError { ... } impl core::fmt::Display for TryFromFloatSecsError { ... } impl core::error::Error for TryFromFloatSecsError { ... } ``` These functions are made const unstable under `duration_consts_float`, tracking issue rust-lang#72440. There is an open question in the tracking issue around what the error type should be called which I was hoping to resolve in the context of an FCP. In this stabilization PR, I have altered the name of the error type to `TryFromFloatSecsError`. In my opinion, the error type shares the name of the method (adjusted to accommodate both types of floats), which is consistent with other error types in `core`, `alloc` and `std` like `TryReserveError` and `TryFromIntError`. ## Experience Report Code such as this is ready to be converted to a checked API to ensure it is panic free: ```rust impl Time { pub fn checked_add_f64(&self, seconds: f64) -> Result<Self, TimeError> { // Fail safely during `f64` conversion to duration if seconds.is_nan() || seconds.is_infinite() { return Err(TzOutOfRangeError::new().into()); } if seconds.is_sign_positive() { self.checked_add(Duration::from_secs_f64(seconds)) } else { self.checked_sub(Duration::from_secs_f64(-seconds)) } } } ``` See: artichoke/artichoke#2194. ``@rustbot`` label +T-libs-api -T-libs cc ``@mbartlett21``

…om-secs-float, r=dtolnay Stabilize `duration_checked_float` ## Stabilization Report This stabilization report is for a stabilization of `duration_checked_float`, tracking issue: rust-lang/rust#83400. ### Implementation History - rust-lang/rust#82179 - rust-lang/rust#90247 - rust-lang/rust#96051 - Changed error type to `FromFloatSecsError` in rust-lang/rust#90247 - rust-lang/rust#96051 changes the rounding mode to round-to-nearest instead of truncate. ## API Summary This stabilization report proposes the following API to be stabilized in `core`, along with their re-exports in `std`: ```rust // core::time impl Duration { pub const fn try_from_secs_f32(secs: f32) -> Result<Duration, TryFromFloatSecsError>; pub const fn try_from_secs_f64(secs: f64) -> Result<Duration, TryFromFloatSecsError>; } #[derive(Debug, Clone, PartialEq, Eq)] pub struct TryFromFloatSecsError { ... } impl core::fmt::Display for TryFromFloatSecsError { ... } impl core::error::Error for TryFromFloatSecsError { ... } ``` These functions are made const unstable under `duration_consts_float`, tracking issue #72440. There is an open question in the tracking issue around what the error type should be called which I was hoping to resolve in the context of an FCP. In this stabilization PR, I have altered the name of the error type to `TryFromFloatSecsError`. In my opinion, the error type shares the name of the method (adjusted to accommodate both types of floats), which is consistent with other error types in `core`, `alloc` and `std` like `TryReserveError` and `TryFromIntError`. ## Experience Report Code such as this is ready to be converted to a checked API to ensure it is panic free: ```rust impl Time { pub fn checked_add_f64(&self, seconds: f64) -> Result<Self, TimeError> { // Fail safely during `f64` conversion to duration if seconds.is_nan() || seconds.is_infinite() { return Err(TzOutOfRangeError::new().into()); } if seconds.is_sign_positive() { self.checked_add(Duration::from_secs_f64(seconds)) } else { self.checked_sub(Duration::from_secs_f64(-seconds)) } } } ``` See: artichoke/artichoke#2194. `@rustbot` label +T-libs-api -T-libs cc `@mbartlett21`

rust-highfive assigned sfackler Feb 16, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 16, 2021

This comment has been minimized.

Sign in to view

crlf0710 added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Mar 5, 2021

JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 22, 2021

mbartlett21 mentioned this pull request Mar 23, 2021

Tracking Issue for Duration::try_from_secs_{f32, f64} #83400

Closed

3 tasks

mbartlett21 changed the title ~~Add functions Duration::try_from_secs_{f32, f64}~~ Add functions Duration::checked_from_secs_{f32, f64} Mar 23, 2021

This comment has been minimized.

Sign in to view

mbartlett21 changed the title ~~Add functions Duration::checked_from_secs_{f32, f64}~~ Add functions Duration::try_from_secs_{f32, f64} Mar 23, 2021

crlf0710 added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 9, 2021

joshtriplett reviewed Apr 21, 2021

View reviewed changes

library/core/src/time.rs Outdated Show resolved Hide resolved

joshtriplett added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 21, 2021

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 22, 2021

JohnCSimon added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 14, 2021

rust-highfive assigned joshtriplett and unassigned sfackler Jun 14, 2021

mbartlett21 force-pushed the patch-5 branch from 7ec2756 to bf27f70 Compare June 14, 2021 11:59

mbartlett21 added 2 commits June 14, 2021 12:16

Add functions Duration::try_from_secs_{f32, f64}

c2c1ca0

This also adds the error type used, `FromSecsError` and its `impl`s.

Use try_from_secs_* in Duration::from_secs_* functions.

7803955

`Duration::from_secs_{f32, f64}` now use the results from the non-panicking functions and unwrap it.

mbartlett21 force-pushed the patch-5 branch from bf27f70 to 7803955 Compare June 14, 2021 12:19

joshtriplett reviewed Jun 14, 2021

View reviewed changes

library/core/src/time.rs Show resolved Hide resolved

JohnTitor closed this Jun 15, 2021

JohnTitor reopened this Jun 15, 2021

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 15, 2021

JohnTitor mentioned this pull request Jun 15, 2021

Rollup of 10 pull requests #86321

Merged

bors merged commit 1e14d39 into rust-lang:master Jun 15, 2021

rustbot added this to the 1.55.0 milestone Jun 15, 2021

jplatte mentioned this pull request Jun 18, 2021

Data to add jplatte/caniuse.rs#16

Open

65 tasks

mbartlett21 deleted the patch-5 branch May 30, 2022 06:19

lopopolo mentioned this pull request Sep 25, 2022

Stabilize duration_checked_float #102271

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add functions `Duration::try_from_secs_{f32, f64}` #82179

Add functions `Duration::try_from_secs_{f32, f64}` #82179

mbartlett21 commented Feb 16, 2021 •

edited

Loading

rust-highfive commented Feb 16, 2021

This comment has been minimized.

This comment has been minimized.

marmeladema commented Feb 16, 2021

jieyouxu commented Feb 16, 2021

marmeladema commented Feb 16, 2021

mbartlett21 commented Feb 17, 2021

Dylan-DPC-zz commented Mar 23, 2021

mbartlett21 commented Mar 23, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

mbartlett21 commented Apr 22, 2021

JohnTitor commented Jun 14, 2021

mbartlett21 commented Jun 14, 2021

joshtriplett commented Jun 14, 2021

joshtriplett commented Jun 15, 2021

JohnTitor commented Jun 15, 2021

bors commented Jun 15, 2021

bors commented Jun 15, 2021

Add functions Duration::try_from_secs_{f32, f64} #82179

Add functions Duration::try_from_secs_{f32, f64} #82179

Conversation

mbartlett21 commented Feb 16, 2021 • edited Loading

rust-highfive commented Feb 16, 2021

This comment has been minimized.

This comment has been minimized.

marmeladema commented Feb 16, 2021

jieyouxu commented Feb 16, 2021

marmeladema commented Feb 16, 2021

mbartlett21 commented Feb 17, 2021

Dylan-DPC-zz commented Mar 23, 2021

mbartlett21 commented Mar 23, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

mbartlett21 commented Apr 22, 2021

JohnTitor commented Jun 14, 2021

mbartlett21 commented Jun 14, 2021

joshtriplett commented Jun 14, 2021

joshtriplett commented Jun 15, 2021

JohnTitor commented Jun 15, 2021

bors commented Jun 15, 2021

bors commented Jun 15, 2021

Add functions `Duration::try_from_secs_{f32, f64}` #82179

Add functions `Duration::try_from_secs_{f32, f64}` #82179

mbartlett21 commented Feb 16, 2021 •

edited

Loading