Safe Haskell	None
Language	Haskell2010

Data.Time.Clock.Units

Description

Types for time intervals of various units. Each newtype wraps DiffTime, but they have different Num instances. The intent is to use the record selectors to write literals with particular units, like this:

>>> milliseconds 500
0.5s
>>> hours 3
10800s
>>> minutes 1.5 + seconds 30
120s

You can also go the other way using the constructors rather than the selectors:

>>> toRational $ Minutes (seconds 17)
17 % 60
>>> realToFrac (Days (hours 12)) :: Double
0.5

NOTE: the Real and Fractional instances just essentially add or strip the unit label (as above), so you can't use realToFrac to convert between the units types here. Instead try convertDuration which is less of a foot-gun.

The Read instances for these types mirror the behavior of the RealFrac instance wrt numeric literals for convenient serialization (e.g. when working with env vars):

>>> read "1.2" :: Milliseconds
Milliseconds {milliseconds = 0.0012s}

Generally, if you need to pass around a duration between functions you should use DiffTime directly. However if storing a duration in a type that will be serialized, e.g. one having a ToJSON instance, it is better to use one of these explicit wrapper types so that it's obvious what units will be used.

Synopsis

newtype Seconds = Seconds {
- seconds :: DiffTime
}
newtype Days = Days {
- days :: DiffTime
}
newtype Hours = Hours {
- hours :: DiffTime
}
newtype Minutes = Minutes {
- minutes :: DiffTime
}
newtype Milliseconds = Milliseconds {
- milliseconds :: DiffTime
}
newtype Microseconds = Microseconds {
- microseconds :: DiffTime
}
newtype Nanoseconds = Nanoseconds {
- nanoseconds :: DiffTime
}
newtype TimeUnit (picosPerUnit :: Nat) = TimeUnit DiffTime
type SecondsP n = n * 1000000000000
natNum :: forall n a. (KnownNat n, Num a) => a
class Duration d where
- fromDiffTime :: DiffTime -> d
- toDiffTime :: d -> DiffTime
convertDuration :: (Duration x, Duration y) => x -> y
diffTimeToMicroSeconds :: DiffTime -> Integer

Documentation

newtype Seconds Source #

Constructors

Seconds
Fields seconds :: DiffTime

Instances

Instances details

Eq Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (==) :: Seconds -> Seconds -> Bool # (/=) :: Seconds -> Seconds -> Bool #
Fractional Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (/) :: Seconds -> Seconds -> Seconds # recip :: Seconds -> Seconds # fromRational :: Rational -> Seconds #
Num Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (+) :: Seconds -> Seconds -> Seconds # (-) :: Seconds -> Seconds -> Seconds # (*) :: Seconds -> Seconds -> Seconds # negate :: Seconds -> Seconds # abs :: Seconds -> Seconds # signum :: Seconds -> Seconds # fromInteger :: Integer -> Seconds #
Ord Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods compare :: Seconds -> Seconds -> Ordering # (<) :: Seconds -> Seconds -> Bool # (<=) :: Seconds -> Seconds -> Bool # (>) :: Seconds -> Seconds -> Bool # (>=) :: Seconds -> Seconds -> Bool # max :: Seconds -> Seconds -> Seconds # min :: Seconds -> Seconds -> Seconds #
Read Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods readsPrec :: Int -> ReadS Seconds # readList :: ReadS [Seconds] # readPrec :: ReadPrec Seconds # readListPrec :: ReadPrec [Seconds] #
Real Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods toRational :: Seconds -> Rational #
RealFrac Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods properFraction :: Integral b => Seconds -> (b, Seconds) # truncate :: Integral b => Seconds -> b # round :: Integral b => Seconds -> b # ceiling :: Integral b => Seconds -> b # floor :: Integral b => Seconds -> b #
Show Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods showsPrec :: Int -> Seconds -> ShowS # show :: Seconds -> String # showList :: [Seconds] -> ShowS #
Hashable Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods hashWithSalt :: Int -> Seconds -> Int hash :: Seconds -> Int
FromJSON Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods parseJSON :: Value -> Parser Seconds parseJSONList :: Value -> Parser [Seconds]
ToJSON Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods toJSON :: Seconds -> Value toEncoding :: Seconds -> Encoding toJSONList :: [Seconds] -> Value toEncodingList :: [Seconds] -> Encoding
Duration Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Seconds Source # toDiffTime :: Seconds -> DiffTime Source #
FromEnv Seconds Source #
Instance details Defined in Hasura.Server.Init.Env Methods fromEnv :: String -> Either String Seconds Source #

newtype Days Source #

Constructors

Days
Fields days :: DiffTime

Instances

Instances details

Eq Days Source #
Instance details Defined in Data.Time.Clock.Units Methods (==) :: Days -> Days -> Bool # (/=) :: Days -> Days -> Bool #
Fractional Days Source #
Instance details Defined in Data.Time.Clock.Units Methods (/) :: Days -> Days -> Days # recip :: Days -> Days # fromRational :: Rational -> Days #
Num Days Source #
Instance details Defined in Data.Time.Clock.Units Methods (+) :: Days -> Days -> Days # (-) :: Days -> Days -> Days # (*) :: Days -> Days -> Days # negate :: Days -> Days # abs :: Days -> Days # signum :: Days -> Days # fromInteger :: Integer -> Days #
Ord Days Source #
Instance details Defined in Data.Time.Clock.Units Methods compare :: Days -> Days -> Ordering # (<) :: Days -> Days -> Bool # (<=) :: Days -> Days -> Bool # (>) :: Days -> Days -> Bool # (>=) :: Days -> Days -> Bool # max :: Days -> Days -> Days # min :: Days -> Days -> Days #
Read Days Source #
Instance details Defined in Data.Time.Clock.Units Methods readsPrec :: Int -> ReadS Days # readList :: ReadS [Days] # readPrec :: ReadPrec Days # readListPrec :: ReadPrec [Days] #
Real Days Source #
Instance details Defined in Data.Time.Clock.Units Methods toRational :: Days -> Rational #
RealFrac Days Source #
Instance details Defined in Data.Time.Clock.Units Methods properFraction :: Integral b => Days -> (b, Days) # truncate :: Integral b => Days -> b # round :: Integral b => Days -> b # ceiling :: Integral b => Days -> b # floor :: Integral b => Days -> b #
Show Days Source #
Instance details Defined in Data.Time.Clock.Units Methods showsPrec :: Int -> Days -> ShowS # show :: Days -> String # showList :: [Days] -> ShowS #
Hashable Days Source #
Instance details Defined in Data.Time.Clock.Units Methods hashWithSalt :: Int -> Days -> Int hash :: Days -> Int
Duration Days Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Days Source # toDiffTime :: Days -> DiffTime Source #

newtype Hours Source #

Constructors

Hours
Fields hours :: DiffTime

Instances

Instances details

Eq Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods (==) :: Hours -> Hours -> Bool # (/=) :: Hours -> Hours -> Bool #
Fractional Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods (/) :: Hours -> Hours -> Hours # recip :: Hours -> Hours # fromRational :: Rational -> Hours #
Num Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods (+) :: Hours -> Hours -> Hours # (-) :: Hours -> Hours -> Hours # (*) :: Hours -> Hours -> Hours # negate :: Hours -> Hours # abs :: Hours -> Hours # signum :: Hours -> Hours # fromInteger :: Integer -> Hours #
Ord Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods compare :: Hours -> Hours -> Ordering # (<) :: Hours -> Hours -> Bool # (<=) :: Hours -> Hours -> Bool # (>) :: Hours -> Hours -> Bool # (>=) :: Hours -> Hours -> Bool # max :: Hours -> Hours -> Hours # min :: Hours -> Hours -> Hours #
Read Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods readsPrec :: Int -> ReadS Hours # readList :: ReadS [Hours] # readPrec :: ReadPrec Hours # readListPrec :: ReadPrec [Hours] #
Real Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods toRational :: Hours -> Rational #
RealFrac Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods properFraction :: Integral b => Hours -> (b, Hours) # truncate :: Integral b => Hours -> b # round :: Integral b => Hours -> b # ceiling :: Integral b => Hours -> b # floor :: Integral b => Hours -> b #
Show Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods showsPrec :: Int -> Hours -> ShowS # show :: Hours -> String # showList :: [Hours] -> ShowS #
Hashable Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods hashWithSalt :: Int -> Hours -> Int hash :: Hours -> Int
Duration Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Hours Source # toDiffTime :: Hours -> DiffTime Source #

newtype Minutes Source #

Constructors

Minutes
Fields minutes :: DiffTime

Instances

Instances details

Eq Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods (==) :: Minutes -> Minutes -> Bool # (/=) :: Minutes -> Minutes -> Bool #
Fractional Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods (/) :: Minutes -> Minutes -> Minutes # recip :: Minutes -> Minutes # fromRational :: Rational -> Minutes #
Num Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods (+) :: Minutes -> Minutes -> Minutes # (-) :: Minutes -> Minutes -> Minutes # (*) :: Minutes -> Minutes -> Minutes # negate :: Minutes -> Minutes # abs :: Minutes -> Minutes # signum :: Minutes -> Minutes # fromInteger :: Integer -> Minutes #
Ord Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods compare :: Minutes -> Minutes -> Ordering # (<) :: Minutes -> Minutes -> Bool # (<=) :: Minutes -> Minutes -> Bool # (>) :: Minutes -> Minutes -> Bool # (>=) :: Minutes -> Minutes -> Bool # max :: Minutes -> Minutes -> Minutes # min :: Minutes -> Minutes -> Minutes #
Read Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods readsPrec :: Int -> ReadS Minutes # readList :: ReadS [Minutes] # readPrec :: ReadPrec Minutes # readListPrec :: ReadPrec [Minutes] #
Real Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods toRational :: Minutes -> Rational #
RealFrac Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods properFraction :: Integral b => Minutes -> (b, Minutes) # truncate :: Integral b => Minutes -> b # round :: Integral b => Minutes -> b # ceiling :: Integral b => Minutes -> b # floor :: Integral b => Minutes -> b #
Show Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods showsPrec :: Int -> Minutes -> ShowS # show :: Minutes -> String # showList :: [Minutes] -> ShowS #
Hashable Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods hashWithSalt :: Int -> Minutes -> Int hash :: Minutes -> Int
Duration Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Minutes Source # toDiffTime :: Minutes -> DiffTime Source #

newtype Milliseconds Source #

Constructors

Milliseconds
Fields milliseconds :: DiffTime

Instances

Instances details

Eq Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (==) :: Milliseconds -> Milliseconds -> Bool # (/=) :: Milliseconds -> Milliseconds -> Bool #
Fractional Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (/) :: Milliseconds -> Milliseconds -> Milliseconds # recip :: Milliseconds -> Milliseconds # fromRational :: Rational -> Milliseconds #
Num Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (+) :: Milliseconds -> Milliseconds -> Milliseconds # (-) :: Milliseconds -> Milliseconds -> Milliseconds # (*) :: Milliseconds -> Milliseconds -> Milliseconds # negate :: Milliseconds -> Milliseconds # abs :: Milliseconds -> Milliseconds # signum :: Milliseconds -> Milliseconds # fromInteger :: Integer -> Milliseconds #
Ord Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods compare :: Milliseconds -> Milliseconds -> Ordering # (<) :: Milliseconds -> Milliseconds -> Bool # (<=) :: Milliseconds -> Milliseconds -> Bool # (>) :: Milliseconds -> Milliseconds -> Bool # (>=) :: Milliseconds -> Milliseconds -> Bool # max :: Milliseconds -> Milliseconds -> Milliseconds # min :: Milliseconds -> Milliseconds -> Milliseconds #
Read Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods readsPrec :: Int -> ReadS Milliseconds # readList :: ReadS [Milliseconds] # readPrec :: ReadPrec Milliseconds # readListPrec :: ReadPrec [Milliseconds] #
Real Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods toRational :: Milliseconds -> Rational #
RealFrac Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods properFraction :: Integral b => Milliseconds -> (b, Milliseconds) # truncate :: Integral b => Milliseconds -> b # round :: Integral b => Milliseconds -> b # ceiling :: Integral b => Milliseconds -> b # floor :: Integral b => Milliseconds -> b #
Show Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods showsPrec :: Int -> Milliseconds -> ShowS # show :: Milliseconds -> String # showList :: [Milliseconds] -> ShowS #
Hashable Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods hashWithSalt :: Int -> Milliseconds -> Int hash :: Milliseconds -> Int
FromJSON Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods parseJSON :: Value -> Parser Milliseconds parseJSONList :: Value -> Parser [Milliseconds]
ToJSON Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods toJSON :: Milliseconds -> Value toEncoding :: Milliseconds -> Encoding toJSONList :: [Milliseconds] -> Value toEncodingList :: [Milliseconds] -> Encoding
Duration Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Milliseconds Source # toDiffTime :: Milliseconds -> DiffTime Source #
FromEnv Milliseconds Source #
Instance details Defined in Hasura.Server.Init.Env Methods fromEnv :: String -> Either String Milliseconds Source #

newtype Microseconds Source #

Constructors

Microseconds
Fields microseconds :: DiffTime

Instances

Instances details

Eq Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (==) :: Microseconds -> Microseconds -> Bool # (/=) :: Microseconds -> Microseconds -> Bool #
Fractional Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (/) :: Microseconds -> Microseconds -> Microseconds # recip :: Microseconds -> Microseconds # fromRational :: Rational -> Microseconds #
Num Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (+) :: Microseconds -> Microseconds -> Microseconds # (-) :: Microseconds -> Microseconds -> Microseconds # (*) :: Microseconds -> Microseconds -> Microseconds # negate :: Microseconds -> Microseconds # abs :: Microseconds -> Microseconds # signum :: Microseconds -> Microseconds # fromInteger :: Integer -> Microseconds #
Ord Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods compare :: Microseconds -> Microseconds -> Ordering # (<) :: Microseconds -> Microseconds -> Bool # (<=) :: Microseconds -> Microseconds -> Bool # (>) :: Microseconds -> Microseconds -> Bool # (>=) :: Microseconds -> Microseconds -> Bool # max :: Microseconds -> Microseconds -> Microseconds # min :: Microseconds -> Microseconds -> Microseconds #
Read Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods readsPrec :: Int -> ReadS Microseconds # readList :: ReadS [Microseconds] # readPrec :: ReadPrec Microseconds # readListPrec :: ReadPrec [Microseconds] #
Real Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods toRational :: Microseconds -> Rational #
RealFrac Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods properFraction :: Integral b => Microseconds -> (b, Microseconds) # truncate :: Integral b => Microseconds -> b # round :: Integral b => Microseconds -> b # ceiling :: Integral b => Microseconds -> b # floor :: Integral b => Microseconds -> b #
Show Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods showsPrec :: Int -> Microseconds -> ShowS # show :: Microseconds -> String # showList :: [Microseconds] -> ShowS #
Hashable Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods hashWithSalt :: Int -> Microseconds -> Int hash :: Microseconds -> Int
Duration Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Microseconds Source # toDiffTime :: Microseconds -> DiffTime Source #

newtype Nanoseconds Source #

Constructors

Nanoseconds
Fields nanoseconds :: DiffTime

Instances

Instances details

Eq Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (==) :: Nanoseconds -> Nanoseconds -> Bool # (/=) :: Nanoseconds -> Nanoseconds -> Bool #
Fractional Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (/) :: Nanoseconds -> Nanoseconds -> Nanoseconds # recip :: Nanoseconds -> Nanoseconds # fromRational :: Rational -> Nanoseconds #
Num Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods (+) :: Nanoseconds -> Nanoseconds -> Nanoseconds # (-) :: Nanoseconds -> Nanoseconds -> Nanoseconds # (*) :: Nanoseconds -> Nanoseconds -> Nanoseconds # negate :: Nanoseconds -> Nanoseconds # abs :: Nanoseconds -> Nanoseconds # signum :: Nanoseconds -> Nanoseconds # fromInteger :: Integer -> Nanoseconds #
Ord Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods compare :: Nanoseconds -> Nanoseconds -> Ordering # (<) :: Nanoseconds -> Nanoseconds -> Bool # (<=) :: Nanoseconds -> Nanoseconds -> Bool # (>) :: Nanoseconds -> Nanoseconds -> Bool # (>=) :: Nanoseconds -> Nanoseconds -> Bool # max :: Nanoseconds -> Nanoseconds -> Nanoseconds # min :: Nanoseconds -> Nanoseconds -> Nanoseconds #
Read Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods readsPrec :: Int -> ReadS Nanoseconds # readList :: ReadS [Nanoseconds] # readPrec :: ReadPrec Nanoseconds # readListPrec :: ReadPrec [Nanoseconds] #
Real Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods toRational :: Nanoseconds -> Rational #
RealFrac Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods properFraction :: Integral b => Nanoseconds -> (b, Nanoseconds) # truncate :: Integral b => Nanoseconds -> b # round :: Integral b => Nanoseconds -> b # ceiling :: Integral b => Nanoseconds -> b # floor :: Integral b => Nanoseconds -> b #
Show Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods showsPrec :: Int -> Nanoseconds -> ShowS # show :: Nanoseconds -> String # showList :: [Nanoseconds] -> ShowS #
Hashable Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods hashWithSalt :: Int -> Nanoseconds -> Int hash :: Nanoseconds -> Int
Duration Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Nanoseconds Source # toDiffTime :: Nanoseconds -> DiffTime Source #

newtype TimeUnit (picosPerUnit :: Nat) Source #

Constructors

TimeUnit DiffTime

type SecondsP n = n * 1000000000000 Source #

natNum :: forall n a. (KnownNat n, Num a) => a Source #

class Duration d where Source #

Duration types isomorphic to DiffTime, powering convertDuration.

Methods

fromDiffTime :: DiffTime -> d Source #

toDiffTime :: d -> DiffTime Source #

Instances

Instances details

Duration NominalDiffTime Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> NominalDiffTime Source # toDiffTime :: NominalDiffTime -> DiffTime Source #
Duration DiffTime Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> DiffTime Source # toDiffTime :: DiffTime -> DiffTime Source #
Duration Nanoseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Nanoseconds Source # toDiffTime :: Nanoseconds -> DiffTime Source #
Duration Microseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Microseconds Source # toDiffTime :: Microseconds -> DiffTime Source #
Duration Milliseconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Milliseconds Source # toDiffTime :: Milliseconds -> DiffTime Source #
Duration Minutes Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Minutes Source # toDiffTime :: Minutes -> DiffTime Source #
Duration Hours Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Hours Source # toDiffTime :: Hours -> DiffTime Source #
Duration Days Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Days Source # toDiffTime :: Days -> DiffTime Source #
Duration Seconds Source #
Instance details Defined in Data.Time.Clock.Units Methods fromDiffTime :: DiffTime -> Seconds Source # toDiffTime :: Seconds -> DiffTime Source #

convertDuration :: (Duration x, Duration y) => x -> y Source #

Safe conversion between duration units.

diffTimeToMicroSeconds :: DiffTime -> Integer Source #