-
Notifications
You must be signed in to change notification settings - Fork 19
Avoid nonstandard use of names for types in wit-0.3.0-draft #79
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.
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
bakkot
wants to merge
2
commits into
WebAssembly:main
Choose a base branch
from
bakkot:clocks-improvements-on-three
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+44
−33
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,11 +9,11 @@ package wasi:[email protected]; | |
/// successive reads of the clock will produce non-decreasing values. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
interface monotonic-clock { | ||
/// An instant in time, in nanoseconds. An instant is relative to an | ||
/// A mark on a monotonic clock is a number of nanoseconds since an | ||
/// unspecified initial value, and can only be compared to instances from | ||
/// the same monotonic-clock. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
type instant = u64; | ||
type mark = u64; | ||
|
||
/// A duration of time, in nanoseconds. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
|
@@ -24,20 +24,20 @@ interface monotonic-clock { | |
/// The clock is monotonic, therefore calling this function repeatedly will | ||
/// produce a sequence of non-decreasing values. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
now: func() -> instant; | ||
now: func() -> mark; | ||
|
||
/// Query the resolution of the clock. Returns the duration of time | ||
/// corresponding to a clock tick. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
get-resolution: func() -> duration; | ||
|
||
/// Wait until the specified instant has occurred. | ||
/// Wait until the specified mark has occurred. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
wait-until: async func( | ||
when: instant, | ||
when: mark, | ||
); | ||
|
||
/// Wait for the specified duration to elapse. | ||
/// Wait for the specified duration. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
wait-for: async func( | ||
how-long: duration, | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,34 @@ | ||
package wasi:[email protected]; | ||
/// WASI Wall Clock is a clock API intended to let users query the current | ||
/// time. The name "wall" makes an analogy to a "clock on the wall", which | ||
/// is not necessarily monotonic as it may be reset. | ||
/// WASI System Clock is a clock API intended to let users query the current | ||
/// time. The clock is not necessarily monotonic as it may be reset. | ||
/// | ||
/// It is intended to be portable at least between Unix-family platforms and | ||
/// Windows. | ||
/// | ||
/// A wall clock is a clock which measures the date and time according to | ||
/// some external reference. | ||
/// | ||
/// External references may be reset, so this clock is not necessarily | ||
/// monotonic, making it unsuitable for measuring elapsed time. | ||
/// | ||
/// It is intended for reporting the current date and time for humans. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
interface wall-clock { | ||
/// A time and date in seconds plus nanoseconds. | ||
interface system-clock { | ||
/// An "instant", or "exact time", is a point in time without regard to any | ||
/// time zone: just the time since a particular external reference point, | ||
/// often called an "epoch". | ||
/// Note that even if the seconds field is negative, incrementing | ||
/// nanoseconds always represents moving forwards in time. | ||
/// For example, `{ -1 seconds, 999999999 nanoseconds }` represents the | ||
/// instant one nanosecond before the epoch. | ||
/// For more on various different ways to represent time, see | ||
/// https://tc39.es/proposal-temporal/docs/timezone.html | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
record instant { | ||
seconds: s64, | ||
nanoseconds: u32, | ||
} | ||
|
||
/// A duration of time, in seconds plus nanoseconds. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
record datetime { | ||
record duration { | ||
seconds: u64, | ||
nanoseconds: u32, | ||
} | ||
|
@@ -36,11 +47,11 @@ interface wall-clock { | |
/// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16 | ||
/// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
now: func() -> datetime; | ||
now: func() -> instant; | ||
|
||
/// Query the resolution of the clock. | ||
/// | ||
/// The nanoseconds field of the output is always less than 1000000000. | ||
@since(version = 0.3.0-rc-2025-08-15) | ||
get-resolution: func() -> datetime; | ||
get-resolution: func() -> duration; | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,23 +3,23 @@ package wasi:[email protected]; | |
@unstable(feature = clocks-timezone) | ||
interface timezone { | ||
@unstable(feature = clocks-timezone) | ||
use wall-clock.{datetime}; | ||
use system-clock.{instant}; | ||
|
||
/// Return information needed to display the given `datetime`. This includes | ||
/// Return information needed to display the given `instant`. This includes | ||
/// the UTC offset, the time zone name, and a flag indicating whether | ||
/// daylight saving time is active. | ||
/// | ||
/// If the timezone cannot be determined for the given `datetime`, return a | ||
/// If the timezone cannot be determined for the given `instant`, return a | ||
/// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight | ||
/// saving time. | ||
@unstable(feature = clocks-timezone) | ||
display: func(when: datetime) -> timezone-display; | ||
display: func(when: instant) -> timezone-display; | ||
|
||
/// The same as `display`, but only return the UTC offset. | ||
@unstable(feature = clocks-timezone) | ||
utc-offset: func(when: datetime) -> s32; | ||
utc-offset: func(when: instant) -> s32; | ||
|
||
/// Information useful for displaying the timezone of a specific `datetime`. | ||
/// Information useful for displaying the timezone of a specific `instant`. | ||
/// | ||
/// This information may vary within a single `timezone` to reflect daylight | ||
/// saving time adjustments. | ||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We originally avoided the term "system clock", but I think it's ok to use now.
Background: we wanted WASI to deemphasize the idea of "the system", because that may suggest a level of monolithicity that we don't want to require. However, if "wall clock" isn't suitable, I'm guessing we won't find any other names that have the desired meaning without risk of being mistaken. So unless we think of some brilliant alternative name, I think "system clock" is the least-problematic option.