Data.MediaBus.Basics.Clock

An interface for clocks. Since there are many ways to calculate different ideas of time, e.g. system time, wall clock time or stream time, a type class Clock is provided with the basic interface for getting the current time and comparing time stamps.

Documentation

class (Default (ClockTimeDiff c), Ord (ClockTimeDiff c), Eq (ClockTimeDiff c), Num (ClockTimeDiff c), Show (ClockTime c), Eq (ClockTime c), Show (ClockTimeDiff c), LocalOrd (ClockTimeDiff c)) => IsClock c where

Clocks can generate reference times, and they can convert these to tickss. Tickss are mere integrals

Minimal complete definition

now, timeAsTimeDiff, diffTime, timeAddTimeDiff

Associated Types

data ClockTime c

data ClockTimeDiff c

type MonadClock c (m :: Type -> Type) :: Constraint

Methods

now :: MonadClock c m => m (ClockTime c)

Return the current absolute time as a ClockTime

timeAsTimeDiff :: ClockTime c -> ClockTimeDiff c

Convert a ClockTime to a ClockTimeDiff by diffTimeing the time with the beginning of time.

diffTime :: ClockTime c -> ClockTime c -> ClockTimeDiff c

The time difference (a ClockTimeDiff) between two ClockTimes

timeAddTimeDiff :: ClockTime c -> ClockTimeDiff c -> ClockTime c

Add the relative time to an absolute time to obtain a new absolute time.

Instances

IsClock * UtcClock

Associated Types

data ClockTime UtcClock (c :: UtcClock) :: *

data ClockTimeDiff UtcClock (c :: UtcClock) :: *

type MonadClock UtcClock (c :: UtcClock) (m :: Type -> Type) :: Constraint

Methods

now :: MonadClock UtcClock c m => m (ClockTime UtcClock c)

timeAsTimeDiff :: ClockTime UtcClock c -> ClockTimeDiff UtcClock c

diffTime :: ClockTime UtcClock c -> ClockTime UtcClock c -> ClockTimeDiff UtcClock c

timeAddTimeDiff :: ClockTime UtcClock c -> ClockTimeDiff UtcClock c -> ClockTime UtcClock c

timeSince :: (IsClock c, MonadClock c m, Monad m) => ClockTime c -> m (ClockTimeDiff c)

Return the time elapsed between since the given absolute time.

data UtcClock

A UTC System Time Clock

Constructors

MkUtcClock

Instances

Generic UtcClock

Associated Types

type Rep UtcClock :: * -> *

Methods

from :: UtcClock -> Rep UtcClock x

to :: Rep UtcClock x -> UtcClock

NFData UtcClock

Methods

rnf :: UtcClock -> ()

IsClock * UtcClock

Associated Types

data ClockTime UtcClock (c :: UtcClock) :: *

data ClockTimeDiff UtcClock (c :: UtcClock) :: *

type MonadClock UtcClock (c :: UtcClock) (m :: Type -> Type) :: Constraint

Methods

now :: MonadClock UtcClock c m => m (ClockTime UtcClock c)

timeAsTimeDiff :: ClockTime UtcClock c -> ClockTimeDiff UtcClock c

diffTime :: ClockTime UtcClock c -> ClockTime UtcClock c -> ClockTimeDiff UtcClock c

timeAddTimeDiff :: ClockTime UtcClock c -> ClockTimeDiff UtcClock c -> ClockTime UtcClock c

Eq (ClockTime * UtcClock)

Methods

(==) :: ClockTime * UtcClock -> ClockTime * UtcClock -> Bool

(/=) :: ClockTime * UtcClock -> ClockTime * UtcClock -> Bool

Eq (ClockTimeDiff * UtcClock)

Methods

(==) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Bool

(/=) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Bool

Num (ClockTimeDiff * UtcClock)

Methods

(+) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

(-) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

(*) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

negate :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

abs :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

signum :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

fromInteger :: Integer -> ClockTimeDiff * UtcClock

Ord (ClockTimeDiff * UtcClock)

Methods

compare :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Ordering

(<) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Bool

(<=) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Bool

(>) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Bool

(>=) :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Bool

max :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

min :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock

Show (ClockTime * UtcClock)

Methods

showsPrec :: Int -> ClockTime * UtcClock -> ShowS

show :: ClockTime * UtcClock -> String

showList :: [ClockTime * UtcClock] -> ShowS

Show (ClockTimeDiff * UtcClock)

Methods

showsPrec :: Int -> ClockTimeDiff * UtcClock -> ShowS

show :: ClockTimeDiff * UtcClock -> String

showList :: [ClockTimeDiff * UtcClock] -> ShowS

Generic (ClockTime * UtcClock)

Associated Types

type Rep (ClockTime * UtcClock) :: * -> *

Methods

from :: ClockTime * UtcClock -> Rep (ClockTime * UtcClock) x

to :: Rep (ClockTime * UtcClock) x -> ClockTime * UtcClock

Generic (ClockTimeDiff * UtcClock)

Associated Types

type Rep (ClockTimeDiff * UtcClock) :: * -> *

Methods

from :: ClockTimeDiff * UtcClock -> Rep (ClockTimeDiff * UtcClock) x

to :: Rep (ClockTimeDiff * UtcClock) x -> ClockTimeDiff * UtcClock

Arbitrary (ClockTime * UtcClock)

Methods

arbitrary :: Gen (ClockTime * UtcClock)

shrink :: ClockTime * UtcClock -> [ClockTime * UtcClock]

Arbitrary (ClockTimeDiff * UtcClock)

Methods

arbitrary :: Gen (ClockTimeDiff * UtcClock)

shrink :: ClockTimeDiff * UtcClock -> [ClockTimeDiff * UtcClock]

Default (ClockTimeDiff * UtcClock)

Methods

def :: ClockTimeDiff * UtcClock

NFData (ClockTime * UtcClock)

Methods

rnf :: ClockTime * UtcClock -> ()

NFData (ClockTimeDiff * UtcClock)

Methods

rnf :: ClockTimeDiff * UtcClock -> ()

LocalOrd (ClockTimeDiff * UtcClock)

Methods

succeeds :: ClockTimeDiff * UtcClock -> ClockTimeDiff * UtcClock -> Bool

type Rep UtcClock

type Rep UtcClock = D1 (MetaData "UtcClock" "Data.MediaBus.Basics.Clock" "mediabus-0.3.2.1-5dJYyJReQmz6GqWaXLa130" False) (C1 (MetaCons "MkUtcClock" PrefixI False) U1)

data ClockTime * UtcClock

data ClockTime * UtcClock = MkUtcClockTime {

• _utcClockTime :: UTCTime

}

data ClockTimeDiff * UtcClock

data ClockTimeDiff * UtcClock = MkUtcClockTimeDiff {

• _utcClockTimeDiff :: NominalDiffTime

}

type MonadClock * UtcClock m

type MonadClock * UtcClock m = MonadIO m

type Rep (ClockTime * UtcClock)

type Rep (ClockTime * UtcClock) = D1 (MetaData "ClockTime" "Data.MediaBus.Basics.Clock" "mediabus-0.3.2.1-5dJYyJReQmz6GqWaXLa130" True) (C1 (MetaCons "MkUtcClockTime" PrefixI True) (S1 (MetaSel (Just Symbol "_utcClockTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UTCTime)))

type Rep (ClockTimeDiff * UtcClock)

type Rep (ClockTimeDiff * UtcClock) = D1 (MetaData "ClockTimeDiff" "Data.MediaBus.Basics.Clock" "mediabus-0.3.2.1-5dJYyJReQmz6GqWaXLa130" True) (C1 (MetaCons "MkUtcClockTimeDiff" PrefixI True) (S1 (MetaSel (Just Symbol "_utcClockTimeDiff") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NominalDiffTime)))

useUtcClock :: Proxy UtcClock

A Proxy for UtcClock

utcClockTimeDiff :: Iso' (ClockTimeDiff UtcClock) NominalDiffTime

An Iso for converting a UtcClock ClockTimeDiff from/to a NominalDiffTime.