Document that monotonic-clock.now doesn't wrap.
#96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
584 years ought to be enough for anyone.
lann
approved these changes
Aug 26, 2025
rvolosatovs
approved these changes
Aug 26, 2025
wingo
reviewed
Aug 27, 2025
wit-0.3.0-draft/monotonic-clock.wit
Outdated
| /// | ||
| /// For completeness, this function traps if it's not possible to represent | ||
| /// the value of the clock in an `instant`. However, since `instant` can | ||
| /// represent over 584 years of time, this is not expected to occur in |
There was a problem hiding this comment.
This works, but only if we also specify some restriction around the base time.
There was a problem hiding this comment.
Or rather, the approach to trap on overflow works, but the comment is misleading: you only get to represent 584 years if your base time is 0. Suggest including language like "implementations should ensure that base time is low enough to allow a sufficient range to monotonic_clock::now()" or something.
There was a problem hiding this comment.
Good point. I've now added wording for this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
584 years ought to be enough for anyone.