Control.Monad.TimeMachine.Engine

MonadTime Class

class Monad m => MonadTime m where

A class of monads in which you can obrain the mocked current time and relevant information.

Minimal complete definition

getCurrentTime, getCurrentTZ, getCurrentTimeScale

Methods

getCurrentTime :: m UTCTime

getCurrentTZ :: m TZ

getCurrentTimeScale :: m TimeScale

Instances

MonadTime IO

Methods

getCurrentTime :: IO UTCTime

getCurrentTZ :: IO TZ

getCurrentTimeScale :: IO TimeScale

MonadIO m => MonadTime (TimeMachineT m)

Methods

getCurrentTime :: TimeMachineT m UTCTime

getCurrentTZ :: TimeMachineT m TZ

getCurrentTimeScale :: TimeMachineT m TimeScale

getTimeZone :: MonadTime m => UTCTime -> m TimeZone

Returns the mocked time zone at the given point of time.

getCurrentTimeZone :: MonadTime m => m TimeZone

Returns the mocked time zone at the mocked current time.

utcToLocalZonedTime :: MonadTime m => UTCTime -> m ZonedTime

Returns the mocked local time at the given point of time.

getZonedTime :: MonadTime m => m ZonedTime

Returns the mocked local time at the mocked current time.

loadLocalTZ :: MonadTime m => m TZ

An alias of getCurrentTZ.

Functions

departFor :: (MonadIO m, MonadTime m) => Destination -> TimeZoneName -> Acceleration -> TimeMachineT m a -> m a

Switches the MonadTime contexts. You can specify all of the point of time, the time zone and the setting of speed for mocking at once.

travelTo :: (MonadIO m, MonadTime m) => Destination -> TimeMachineT m a -> m a

Switches the mocked current time in the context.

backTo :: (MonadIO m, MonadTime m) => Destination -> TimeMachineT m a -> m a

An alias of travelTo.

jumpTo :: (MonadIO m, MonadTime m) => TimeZoneName -> TimeMachineT m a -> m a

Switches the mocked current time zone in the context.

accelerate :: (MonadIO m, MonadTime m) => Acceleration -> TimeMachineT m a -> m a

Changes the mocked speed of time in the context.

halt :: (MonadIO m, MonadTime m) => TimeMachineT m a -> m a

Stops the time to advence in the context.

Configurations

newtype TimeScale

A data type to represents the speed of time. It corresponds how many seconds are in the real second, i.e. TimeScale 1 is equivalent to the real speed of time.

Constructors

TimeScale

Fields

• unTimeScale :: NominalDiffTime

Instances

Eq TimeScale

Methods

(==) :: TimeScale -> TimeScale -> Bool

(/=) :: TimeScale -> TimeScale -> Bool

Num TimeScale

Methods

(+) :: TimeScale -> TimeScale -> TimeScale

(-) :: TimeScale -> TimeScale -> TimeScale

(*) :: TimeScale -> TimeScale -> TimeScale

negate :: TimeScale -> TimeScale

abs :: TimeScale -> TimeScale

signum :: TimeScale -> TimeScale

fromInteger :: Integer -> TimeScale

Ord TimeScale

Methods

compare :: TimeScale -> TimeScale -> Ordering

(<) :: TimeScale -> TimeScale -> Bool

(<=) :: TimeScale -> TimeScale -> Bool

(>) :: TimeScale -> TimeScale -> Bool

(>=) :: TimeScale -> TimeScale -> Bool

max :: TimeScale -> TimeScale -> TimeScale

min :: TimeScale -> TimeScale -> TimeScale

Show TimeScale

Methods

showsPrec :: Int -> TimeScale -> ShowS

show :: TimeScale -> String

showList :: [TimeScale] -> ShowS

data Destination

A data type to represent a point of time for mocking.

Constructors

None

Nothing to mock.

Absolute UTCTime

An absolute point in UTC.

Zoned LocalTime

A local time in the mocked current time zone.

Relative TimeInterval

An interval from the mocked current time.

Instances

Eq Destination

Methods

(==) :: Destination -> Destination -> Bool

(/=) :: Destination -> Destination -> Bool

Show Destination

Methods

showsPrec :: Int -> Destination -> ShowS

show :: Destination -> String

showList :: [Destination] -> ShowS

data TimeInterval

A data type to represent intervals for constructing a Destination.

Constructors

Minutes Integer

Hours Integer

Days Integer

Weeks Integer

Months Integer

Years Integer

Instances

Eq TimeInterval

Methods

(==) :: TimeInterval -> TimeInterval -> Bool

(/=) :: TimeInterval -> TimeInterval -> Bool

Show TimeInterval

Methods

showsPrec :: Int -> TimeInterval -> ShowS

show :: TimeInterval -> String

showList :: [TimeInterval] -> ShowS

type TimeZoneName = String

Names of time zones, e.g. "Asia/Tokyo" or "Europe/Paris".

data Acceleration

A data type to represent how to change the mocked speed of time.

Constructors

Keep

Nothing to change.

Velocity TimeScale

Sets the speed to the given scale.

Factor TimeScale

Sets the speed acccording to the current speed.

Instances

Eq Acceleration

Methods

(==) :: Acceleration -> Acceleration -> Bool

(/=) :: Acceleration -> Acceleration -> Bool

Show Acceleration

Methods

showsPrec :: Int -> Acceleration -> ShowS

show :: Acceleration -> String

showList :: [Acceleration] -> ShowS

Monad Transformer

data TimeMachineT m a

A monad transformer to stack the MonadTime contexts.

Instances

MonadTrans TimeMachineT

Methods

lift :: Monad m => m a -> TimeMachineT m a

Monad m => Monad (TimeMachineT m)

Methods

(>>=) :: TimeMachineT m a -> (a -> TimeMachineT m b) -> TimeMachineT m b

(>>) :: TimeMachineT m a -> TimeMachineT m b -> TimeMachineT m b

return :: a -> TimeMachineT m a

fail :: String -> TimeMachineT m a

Functor m => Functor (TimeMachineT m)

Methods

fmap :: (a -> b) -> TimeMachineT m a -> TimeMachineT m b

(<$) :: a -> TimeMachineT m b -> TimeMachineT m a

Applicative m => Applicative (TimeMachineT m)

Methods

pure :: a -> TimeMachineT m a

(<*>) :: TimeMachineT m (a -> b) -> TimeMachineT m a -> TimeMachineT m b

(*>) :: TimeMachineT m a -> TimeMachineT m b -> TimeMachineT m b

(<*) :: TimeMachineT m a -> TimeMachineT m b -> TimeMachineT m a

MonadIO m => MonadIO (TimeMachineT m)

Methods

liftIO :: IO a -> TimeMachineT m a

MonadIO m => MonadTime (TimeMachineT m)

Methods

getCurrentTime :: TimeMachineT m UTCTime

getCurrentTZ :: TimeMachineT m TZ

getCurrentTimeScale :: TimeMachineT m TimeScale