Time

Time unit is represented as type level rational multiplier with kind Rat.

Type family for prettier show of time units.

Constraint alias for KnownSymbol UnitName.

Constraint alias for KnownUnitName and KnownRat for time unit.

Returns type-level Symbol of the time unit converted to String.

Creates Time of some type from given Natural.

Similar to floor, but works with Time units.

>>> floorUnit @Day (Time $ 5 % 2)
2d

>>> floorUnit (Time @Second $ 2 % 3)
0s

>>> floorUnit $ ps 42
42ps

Convert time to the Num in given units.

For example, instead of writing

foo :: POSIXTime
foo = 10800  -- 3 hours

one can write more safe implementation:

foo = toNum @Second $ hour 3

Examples:

>>> toNum @Second @Natural $ hour 3
10800

>>> toNum @Minute @Int $ hour 3
180

>>> toNum @Hour @Natural $ hour 3
3

Creates Second from given Natural.

>>> sec 42
42s

Creates Millisecond from given Natural.

>>> ms 42
42ms

Creates Microsecond from given Natural.

>>> mcs 42
42mcs

Creates Nanosecond from given Natural.

>>> ns 42
42ns

Creates Picosecond from given Natural.

>>> ps 42
42ps

Creates Minute from given Natural.

>>> minute 42
42m

Creates Hour from given Natural.

>>> hour 42
42h

Creates Day from given Natural.

>>> day 42
42d

Creates Week from given Natural.

>>> week 42
42w

Creates Fortnight from given Natural.

>>> fortnight 42
42fn

Converts from one time unit to another time unit.

>>> toUnit @Hour (120 :: Time Minute)
2h

>>> toUnit @Second (ms 7)
7/1000s

>>> toUnit @Week (Time @Day 45)
6+3/7w

>>> toUnit @Second @Minute 3
180s

>>> toUnit (day 42000000) :: Time Second
3628800000000s

Convenient version of threadDelay which takes any time-unit and operates in any MonadIO.

>>> threadDelay $ sec 2
>>> threadDelay (2 :: Time Second)
>>> threadDelay @Second 2

Similar to getCPUTime but returns the CPU time used by the current program in the given time unit. The precision of this result is implementation-dependent.

>>> getCPUTime @Second
1064046949/1000000000s

Similar to timeout but receiving any time unit instead of number of microseconds.

>>> timeout (sec 1) (putStrLn "Hello O'Clock")
Hello O'Clock
Just ()

>>> timeout (ps 1) (putStrLn "Hello O'Clock")
Nothing

>>> timeout (mcs 1) (putStrLn "Hello O'Clock")
HellNothing