Modulemonad-time-effectful-1.0.1.0Haskell2010

Effectful.Time

Time measurement via MonadTime.

1 type
1 class
3 values

Packagemonad-time-effectful-1.0.1.0
Exports5
LanguageHaskell2010
LicenceMIT
SourceTime.hs

Effect

2 declarations

datadata Time (a :: Type -> Type) b where

Provide the ability to use the MonadTime instance of Eff.

Constructors

CurrentTime :: Time a UTCTime
MonotonicTime :: Time a Double

Instances1DispatchOf

type DispatchOf Time = 'DynamicDefined in monad-time-effectful-1.0.1.0 · Effectful.Time

classclass Monad m => MonadTime (m :: Type -> Type) where

Class of monads which make it possible to measure time.

Methods

currentTime :: m UTCTime
monotonicTime :: m Double

Instances3MonadTime

MonadTime IODefined in monad-time-0.4.0.0 · Control.Monad.Time
Base instance for IO.
Time :> es => MonadTime (Eff es)Defined in monad-time-effectful-1.0.1.0 · Effectful.Time · orphan
(MonadTime m, MonadTrans t, Monad (t m)) => MonadTime (t m)Defined in monad-time-0.4.0.0 · Control.Monad.Time
Generic, overlapping instance.

Handlers

valuerunTime :: IOE :> es => Eff (Time ': es) a -> Eff es a

Run a Time effect via IO.

valuerunFrozenTime :: IOE :> es => UTCTime -> Eff (Time ': es) a -> Eff es a

Run a Time effect with a frozen value of the CurrentTime operation.

Note: the MonotonicTime operation works the same way as in runTime.

valuerunFixedStepTime

:: IOE :> es
=> UTCTime
-> NominalDiffTime
-> Eff (Time ': es) a
-> Eff es a

Run the Time effect with a given starting time; time advances by a fixed increment for every invocation of the CurrentTime operation. A negative increment will make the clock run backwards.

Note: the MonotonicTime operation works the same way as in runTime.

Orphan instances

1 instance

Time :> es => MonadTime (Eff es)