Copyright	(c) Ryota Kameoka 2018
License	BSD-3
Maintainer	kameoka.ryota@gmail.com
Stability	experimental
Safe Haskell	Safe
Language	Haskell2010

Data.Time.Clock.Duration.Types

Contents

Type classes
Data types

Description

This module exports internally used type classes and data types. You can extend this package's functionality by utilizing them.

Synopsis

class AbsoluteDuration a where
- toAbsoluteDuration :: Time -> a
class RelativeDuration a where
- toRelativeDuration :: HasResolution r => Proxy r -> Time -> a
data Time
- = Picosec Rational
- | Nanosec Rational
- | Microsec Rational
- | Millisec Rational
- | Second Rational
- | Minute Rational
- | Hour Rational
- | Day Rational
- | Week Rational
- | Year Rational

Type classes

class AbsoluteDuration a where #

The AbsoluteDuration class provides how to convert the given Time into a specific unit of time. An instance should represent a quantity with the dimension of T.

42 seconds in DiffTime (seconds):

>>> [t| 42s |] :: DiffTime
42s

42 seconds in CUSeconds (microseconds):

>>> [t| 42s |] :: CUSeconds
42000000

Methods

toAbsoluteDuration :: Time -> a #

Instances

AbsoluteDuration CUSeconds #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toAbsoluteDuration :: Time -> CUSeconds #
AbsoluteDuration CSUSeconds #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toAbsoluteDuration :: Time -> CSUSeconds #
AbsoluteDuration NominalDiffTime #
Instance details Defined in Data.Time.Clock.Duration.Types Methods toAbsoluteDuration :: Time -> NominalDiffTime #
AbsoluteDuration DiffTime #
Instance details Defined in Data.Time.Clock.Duration.Types Methods toAbsoluteDuration :: Time -> DiffTime #

class RelativeDuration a where #

The RelativeDuration class represents how to calculate how long the given Time is when measured in a specific unit of time. An instance should represent a quantity with the dimension of 1.

42 minutes in seconds:

>>> [s| 42m |] :: Int
2520

3 seconds in microseconds:

>>> [µs| 3s |] :: Int
3000000

Methods

toRelativeDuration :: HasResolution r => Proxy r -> Time -> a #

Instances

RelativeDuration Double #
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Double #
RelativeDuration Float #
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Float #
RelativeDuration Int #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Int #
RelativeDuration Int8 #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Int8 #
RelativeDuration Int16 #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Int16 #
RelativeDuration Int32 #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Int32 #
RelativeDuration Int64 #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Int64 #
RelativeDuration Integer #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Integer #
Integral a => RelativeDuration (Ratio a) #
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Ratio a #
HasResolution a => RelativeDuration (Fixed a) #	Caution: the fractional part will be rounded.
Instance details Defined in Data.Time.Clock.Duration.Types Methods toRelativeDuration :: HasResolution r => Proxy r -> Time -> Fixed a #

Data types

data Time #

The parsing result of a string inside a quasiquoter.

Constructors

Picosec Rational
Nanosec Rational
Microsec Rational
Millisec Rational	Denoted by `ms`, `msec`, `msecs`, `millisecond`, or `milliseconds`
Second Rational	Denoted by `s`, `sec`, `secs`, `second`, or `seconds`
Minute Rational	Denoted by `m`, `min`, `mins`, `minute`, or `minutes`
Hour Rational	Denoted by `h`, `hr`, `hrs`, `hour`, or `hours`
Day Rational	Denoted by `d`, `day`, or `days`
Week Rational	Denoted by `w`, `week`, or `weeks`
Year Rational	Denoted by `y`, `yr`, `yrs`, `year`, or `years`

Instances

Lift Time #
Instance details Defined in Data.Time.Clock.Duration.Types Methods lift :: Time -> Q Exp #