Add Duration type to std and use it in Timer methods. #15934

brson · 2014-07-24T01:18:59Z

Currently, the Timer methods take an integer number of ms. This is considered a bug because a) types, b) some timers have ns precision.

This plucks the Duration type from rust-chrono, plops it into std::time, and replaces the arguments to sleep, oneshot, and periodic timers with it. It leaves the old methods intact as sleep_ms, oneshot_ms, and periodic_ms, for convenience.

Closes #11189.

cc @lifthrasiir @aturon @kballard @alexcrichton

alexcrichton · 2014-07-24T01:54:49Z

src/libstd/time.rs

+        let hasdate = self.days != 0;
+        let hastime = (self.secs != 0 || self.nanos != 0) || !hasdate;
+
+        try!('P'.fmt(f));


Using fmt passes through all format qualifiers like width and such, which probably isn't desired for just the single character P (this may want to be write!)

I've fixed this issue on f7065f16254e3e9853e8d82777575ba3b343b952. I didn't think about format specifiers at all, thank you for pointing out that.

alexcrichton · 2014-07-24T01:59:41Z

Some other thoughts:

Implementation-wise, this is a candidate for residing in libcore. Functionality-wise, I'm not sure if it belongs in libcore.
The name "time" implies functionality like getting the current time, but the name "duration" is quite long.
I wouldn't expect the duplication of foo_ms, I would expect them all to be deprecated/removed

alexcrichton · 2014-07-24T02:01:38Z

This is also quite a bold step forward to claim that we have the "one true" Duration type, so we should proceed cautiously. This module, however, seems to be of high quality, so I don't expect that to be too much of a problem.

In general the documentation of this module is pretty scarce, and would be nice to beef up things like the documentation on Duration, the module, and cases like why new can fail.

huonw · 2014-07-24T02:51:23Z

The name "time" implies functionality like getting the current time

Presumably this module can/will become the facade for what is now libtime (i.e. will be extended so that the time name fits properly).

lilyball · 2014-07-24T02:55:40Z

src/libstd/time.rs

+pub static MAX_DAYS: i32 = i32::MAX;
+
+static NANOS_PER_SEC: i32 = 1_000_000_000;
+static SECS_PER_DAY: i32 = 86400;


There's precedence for the name NSEC_PER_SEC, so it might make sense to use that here.

Why SECS_PER_DAY? You're not using a static for the other durations, you're using magic numbers instead. NSEC_PER_SEC makes sense because it's easy to lose track of the right number of zeros, but the numbers like 60, 3600, 86400 are much more recognizable and don't necessarily need a static. If you want to keep this static, then you should add ones for 60, 3600. You should also add e.g. MSEC_PER_NSEC and USEC_PER_SEC instead of using magic numbers there as well.

lilyball · 2014-07-24T03:50:57Z

Like @alexcrichton, I'm not thrilled about the foo_ms functions, I'd rather see them go away (since the names are being reused they can't merely be deprecated).

I'd also like to see a mechanism to convert a Duration back into a numeric value with a given period. I see three general approaches that could work here:

A bunch of methods, to_ms(), to_ns(), etc (which would all return signed values).
Phantom types for each period (that all implement a trait that provides the conversion between the period and nanoseconds, which would incidentally allow users to define custom periods if that's helpful). This is nice because it could get rid of the plethora of existing constructor methods too, leaving just
```
pub fn new<T: Period>(period: T, value: i64) -> Duration;
pub fn from_parts(days: i32, seconds: u32, nanoseconds: u32) -> Duration;
```
Extracting the value would then look like:
```
pub fn ticks<T: Period>(&self, period: T) -> i64;
```
Phantom types for each period again, but make Duration be specialized on it instead. This one would be similar to C++'s std::chrono::duration. Not sure if there's a compelling reason to do this over approach 2.

I think approach 2 might be the best.

…#15934)

…X}_{DAYS,YEAR}`. the minimum and maximum for `DateZ` and `Duration` is now provided via dedicated constants `{date,duration}::{MIN,MAX}`, much like built-in `std::int` and others. they also now implements `std::num::Bounded`. cf. rust-lang/rust#15934

ISO 8601 allows for both but prefers `,`, which was a main reason for its use in rust-chrono. but this is too alien given other usages of decimal points in Rust, so I guess it is better to switch to `.`.

lifthrasiir · 2014-07-25T08:41:22Z

I didn't notice this issue until today, sorry for late replies. Many design issues in rust-chrono are there because I've experimented with different designs (and forgot to revert); feel free to cricitize. As a first step, I've fixed some outstanding issues in rust-chrono.

brson · 2014-08-12T23:26:27Z

Rebased and added a FIXME about the representation of Duration, with a link to #16466.

aturon · 2014-08-12T23:31:46Z

OK, looks like all major and many minor comments addressed. Thanks for pushing on this! Let's send it to bors and change the representation in follow-up work.

aturon · 2014-08-13T00:45:59Z

@brson About the test failure here -- I just landed a patch that checks for deprecation both cross-crate and crate-locally (whereas other stability lints like the unstable lint are checked only cross-crate). This has been turning up various uses of deprecated items. Looks like that's what happened here.

Taken from rust-chrono[1]. Needed for timers per rust-lang#11189. Experimental. [1]: https://github.com/lifthrasiir/rust-chrono

Rename io::timer::sleep, Timer::sleep, Timer::oneshot, Timer::periodic, to sleep_ms, oneshot_ms, periodic_ms. These functions all take an integer and interpret it as milliseconds. Replacement functions will be added that take Duration. [breaking-change]

From rust-chrono 4f34003e03e259bd5cbda0cb4d35325861307cc6

This is a workaround for having to write `Zero::zero` and will be solved at the language level someday.

Add tests. Also fix a bunch of broken time tests.

[breaking-change]

This is only breaking if you were previously specifying a duration of zero for some mysterious reason. [breaking-change]

Put `Duration` in `time::duration`, where the two constants can be called just `MAX` and `MIN`. Reexport from `time`. This provides more room for the time module to expand.

[breaking-change]

These all expose the underlying data representation and are not the most convenient way of instantiation anyway.

@lifthrasiir

Currently, the Timer methods take an integer number of ms. This is considered a bug because a) types, b) some timers have ns precision. This plucks the `Duration` type from [rust-chrono](https://github.com/lifthrasiir/rust-chrono), plops it into `std::time`, and replaces the arguments to `sleep`, `oneshot`, and `periodic` timers with it. It leaves the old methods intact as `sleep_ms`, `oneshot_ms`, and `periodic_ms`, for convenience. Closes #11189. cc @lifthrasiir @aturon @kballard @alexcrichton

[This pull request][1] changed the timer function signatures. I make the code build again. [1]: rust-lang/rust#15934

alexcrichton reviewed Jul 24, 2014
View reviewed changes

lilyball reviewed Jul 24, 2014
View reviewed changes

lifthrasiir added a commit to chronotope/chrono that referenced this pull request Jul 25, 2014

fixed erratic fmt behaviors with format specifiers. (rust-lang/rust…

f7065f1

…#15934)

brson added 22 commits August 13, 2014 11:31

std: Add a Duration type

5778ed4

Taken from rust-chrono[1]. Needed for timers per rust-lang#11189. Experimental. [1]: https://github.com/lifthrasiir/rust-chrono

std: Add sleep, oneshot and periodic timers, taking Duration

dc8b23b

std: Add comments to the time module

18f75a9

std: Update Duration from upstream

6cb2093

From rust-chrono 4f34003e03e259bd5cbda0cb4d35325861307cc6

std: Change time::MAX to time::MAX_DURATION, etc.

51e9728

std: Remove ms-taking methods from timers

1666dab

std: Remove the zero constructor from Duration

8a5fe86

This is a workaround for having to write `Zero::zero` and will be solved at the language level someday.

std: Restore missing timer examples

734834c

std: Clarify what timers do with zero and negative durations

63cd4ac

Add tests. Also fix a bunch of broken time tests.

std: Make the TCP/UDP connect_timeout methods take Duration

9fdcddb

[breaking-change]

std: connect_timeout requires a positive Duration

4475e6a

This is only breaking if you were previously specifying a duration of zero for some mysterious reason. [breaking-change]

std: Refactor time module a bit

77cdaf0

Put `Duration` in `time::duration`, where the two constants can be called just `MAX` and `MIN`. Reexport from `time`. This provides more room for the time module to expand.

Fix compiletest to use Duration

80d3243

Fix various fallout from timer changes

a391934

std: Make connect_timeout return Err on zero duration

ee10f35

[breaking-change]

std: Improve Duration comments

c6b02f6

std: Remove Duration::new/new_opt/to_tuple

500b600

These all expose the underlying data representation and are not the most convenient way of instantiation anyway.

std: Fix build errors

31281b4

Update docs

49a40d8

Add a fixme about Duration representation

02e39b0

Fix test fallout

075256a

bors closed this Aug 14, 2014

mwhittaker added a commit to mwhittaker/raft that referenced this pull request Aug 15, 2014

Fixed no-compile.

ace0222

[This pull request][1] changed the timer function signatures. I make the code build again. [1]: rust-lang/rust#15934

djc mentioned this pull request Sep 7, 2023

Feedback on swapping out the chrono::Duration type chronotope/chrono#1268

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Duration type to std and use it in Timer methods. #15934

Add Duration type to std and use it in Timer methods. #15934

brson commented Jul 24, 2014

alexcrichton Jul 24, 2014

lifthrasiir Jul 25, 2014

alexcrichton commented Jul 24, 2014

alexcrichton commented Jul 24, 2014

huonw commented Jul 24, 2014

lilyball Jul 24, 2014

lilyball commented Jul 24, 2014

lifthrasiir commented Jul 25, 2014

brson commented Aug 12, 2014

aturon commented Aug 12, 2014

aturon commented Aug 13, 2014

Add Duration type to std and use it in Timer methods. #15934

Add Duration type to std and use it in Timer methods. #15934

Conversation

brson commented Jul 24, 2014

alexcrichton Jul 24, 2014

Choose a reason for hiding this comment

lifthrasiir Jul 25, 2014

Choose a reason for hiding this comment

alexcrichton commented Jul 24, 2014

alexcrichton commented Jul 24, 2014

huonw commented Jul 24, 2014

lilyball Jul 24, 2014

Choose a reason for hiding this comment

lilyball commented Jul 24, 2014

lifthrasiir commented Jul 25, 2014

brson commented Aug 12, 2014

aturon commented Aug 12, 2014

aturon commented Aug 13, 2014