| 1 |
package wasi:[email protected]; |
| 2 |
/// WASI Wall Clock is a clock API intended to let users query the current |
| 3 |
/// time. The name "wall" makes an analogy to a "clock on the wall", which |
| 4 |
/// is not necessarily monotonic as it may be reset. |
| 5 |
/// |
| 6 |
/// It is intended to be portable at least between Unix-family platforms and |
| 7 |
/// Windows. |
| 8 |
/// |
| 9 |
/// A wall clock is a clock which measures the date and time according to |
| 10 |
/// some external reference. |
| 11 |
/// |
| 12 |
/// External references may be reset, so this clock is not necessarily |
| 13 |
/// monotonic, making it unsuitable for measuring elapsed time. |
| 14 |
/// |
| 15 |
/// It is intended for reporting the current date and time for humans. |
| 16 |
@since(version = 0.2.0) |
| 17 |
interface wall-clock { |
| 18 |
/// A time and date in seconds plus nanoseconds. |
| 19 |
@since(version = 0.2.0) |
| 20 |
record datetime { |
| 21 |
seconds: u64, |
| 22 |
nanoseconds: u32, |
| 23 |
} |
| 24 |
|
| 25 |
/// Read the current value of the clock. |
| 26 |
/// |
| 27 |
/// This clock is not monotonic, therefore calling this function repeatedly |
| 28 |
/// will not necessarily produce a sequence of non-decreasing values. |
| 29 |
/// |
| 30 |
/// The returned timestamps represent the number of seconds since |
| 31 |
/// 1970-01-01T00:00:00Z, also known as [POSIX's Seconds Since the Epoch], |
| 32 |
/// also known as [Unix Time]. |
| 33 |
/// |
| 34 |
/// The nanoseconds field of the output is always less than 1000000000. |
| 35 |
/// |
| 36 |
/// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16 |
| 37 |
/// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time |
| 38 |
@since(version = 0.2.0) |
| 39 |
now: func() -> datetime; |
| 40 |
|
| 41 |
/// Query the resolution of the clock. |
| 42 |
/// |
| 43 |
/// The nanoseconds field of the output is always less than 1000000000. |
| 44 |
@since(version = 0.2.0) |
| 45 |
resolution: func() -> datetime; |
| 46 |
} |