Safe Haskell	Safe
Language	Haskell2010

Data.Time.Utils

Contents

Types
Lenses
Constructors
Impure Functions
Pure Functions

Description

timeutils

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Synopsis

data Timer = Timer {
- timerOffset :: NominalDiffTime
- timerStartTime :: Maybe UTCTime
}
data TimeParts = TimeParts {
- tpDays :: Int
- tpHours :: Int
- tpMinutes :: Int
- tpSeconds :: Int
- tpMillis :: Int
}
data Countdown = Countdown {
- countdownLength :: NominalDiffTime
- countdownTimer :: Timer
}
data Stopwatch = Stopwatch {
- stopwatchTimer :: Timer
- stopwatchLaps :: [NominalDiffTime]
}
timerOffsetL :: Lens' Timer NominalDiffTime
timerStartTimeL :: Lens' Timer (Maybe UTCTime)
tpDaysL :: Lens' TimeParts Int
tpHoursL :: Lens' TimeParts Int
tpMinutesL :: Lens' TimeParts Int
tpSecondsL :: Lens' TimeParts Int
tpMillisL :: Lens' TimeParts Int
countdownLengthL :: Lens' Countdown NominalDiffTime
countdownTimerL :: Lens' Countdown Timer
stopwatchTimerL :: Lens' Stopwatch Timer
stopwatchLapsL :: Lens' Stopwatch [NominalDiffTime]
newTimer :: Timer
newTimeParts :: TimeParts
newCountdown :: NominalDiffTime -> Countdown
newStopwatch :: Stopwatch
startTimer :: Timer -> IO Timer
stopTimer :: Timer -> IO Timer
timeElapsed :: Timer -> IO NominalDiffTime
startCountdown :: Countdown -> IO Countdown
stopCountdown :: Countdown -> IO Countdown
timeRemaining :: Countdown -> IO NominalDiffTime
countdownIsCompleted :: Countdown -> IO Bool
startStopwatch :: Stopwatch -> IO Stopwatch
stopStopwatch :: Stopwatch -> IO Stopwatch
newLap :: Stopwatch -> IO Stopwatch
currentLap :: Stopwatch -> IO NominalDiffTime
allLaps :: Stopwatch -> IO [NominalDiffTime]
totalStopwatchTime :: Stopwatch -> IO NominalDiffTime
decomposeNDT :: NominalDiffTime -> TimeParts
composeNDT :: TimeParts -> NominalDiffTime
humanNDT :: NominalDiffTime -> String
timerIsRunning :: Timer -> Bool
timerIsStarted :: Timer -> Bool
startTimerAt :: UTCTime -> Timer -> Timer
stopTimerAt :: UTCTime -> Timer -> Timer
timeElapsedAt :: UTCTime -> Timer -> NominalDiffTime
countdownIsRunning :: Countdown -> Bool
countdownIsStarted :: Countdown -> Bool
startCountdownAt :: UTCTime -> Countdown -> Countdown
stopCountdownAt :: UTCTime -> Countdown -> Countdown
timeRemainingAt :: UTCTime -> Countdown -> NominalDiffTime
countdownIsCompletedAt :: UTCTime -> Countdown -> Bool
stopwatchIsRunning :: Stopwatch -> Bool
stopwatchIsStarted :: Stopwatch -> Bool
startStopwatchAt :: UTCTime -> Stopwatch -> Stopwatch
stopStopwatchAt :: UTCTime -> Stopwatch -> Stopwatch
newLapAt :: UTCTime -> Stopwatch -> Stopwatch
currentLapAt :: UTCTime -> Stopwatch -> NominalDiffTime
allLapsAt :: UTCTime -> Stopwatch -> [NominalDiffTime]
totalStopwatchTimeAt :: UTCTime -> Stopwatch -> NominalDiffTime

Types

data Timer Source #

A type that keeps track of the passage of time

Constructors

Timer
Fields timerOffset :: NominalDiffTime The amount of time previously logged timerStartTime :: Maybe UTCTime The time the `Timer` was last started (`Nothing` if not currently running)

Instances

Eq Timer Source #
Instance details Defined in Data.Time.Utils Methods (==) :: Timer -> Timer -> Bool # (/=) :: Timer -> Timer -> Bool #
Show Timer Source #
Instance details Defined in Data.Time.Utils Methods showsPrec :: Int -> Timer -> ShowS # show :: Timer -> String # showList :: [Timer] -> ShowS #

data TimeParts Source #

Represents a NominalDiffTime broken down into days, hours, minutes, seconds and milliseconds

Constructors

TimeParts
Fields tpDays :: Int The number of days tpHours :: Int The number of hours tpMinutes :: Int The number of minutes tpSeconds :: Int The number of seconds tpMillis :: Int The number of milliseconds

Instances

Eq TimeParts Source #
Instance details Defined in Data.Time.Utils Methods (==) :: TimeParts -> TimeParts -> Bool # (/=) :: TimeParts -> TimeParts -> Bool #
Show TimeParts Source #
Instance details Defined in Data.Time.Utils Methods showsPrec :: Int -> TimeParts -> ShowS # show :: TimeParts -> String # showList :: [TimeParts] -> ShowS #

data Countdown Source #

Represents a timed countdown

Constructors

Countdown
Fields countdownLength :: NominalDiffTime The length of time countdownTimer :: Timer The timer which runs the `Countdown`

Instances

Eq Countdown Source #
Instance details Defined in Data.Time.Utils Methods (==) :: Countdown -> Countdown -> Bool # (/=) :: Countdown -> Countdown -> Bool #
Show Countdown Source #
Instance details Defined in Data.Time.Utils Methods showsPrec :: Int -> Countdown -> ShowS # show :: Countdown -> String # showList :: [Countdown] -> ShowS #

data Stopwatch Source #

Tracks the time of multiple laps

Constructors

Stopwatch
Fields stopwatchTimer :: Timer The `Timer` for the current lap stopwatchLaps :: [NominalDiffTime] The times of previous laps (most recent first)

Instances

Eq Stopwatch Source #
Instance details Defined in Data.Time.Utils Methods (==) :: Stopwatch -> Stopwatch -> Bool # (/=) :: Stopwatch -> Stopwatch -> Bool #
Show Stopwatch Source #
Instance details Defined in Data.Time.Utils Methods showsPrec :: Int -> Stopwatch -> ShowS # show :: Stopwatch -> String # showList :: [Stopwatch] -> ShowS #

Lenses

Timer Lenses

timerOffsetL :: Lens' Timer NominalDiffTime Source #

Lens for the timerOffset attribute

timerStartTimeL :: Lens' Timer (Maybe UTCTime) Source #

Lens for the timerStartTime attribute

TimeParts Lenses

tpDaysL :: Lens' TimeParts Int Source #

Lens for the tpDays attribute

tpHoursL :: Lens' TimeParts Int Source #

Lens for the tpHours attribute

tpMinutesL :: Lens' TimeParts Int Source #

Lens for the tpMinutes attribute

tpSecondsL :: Lens' TimeParts Int Source #

Lens for the tpSeconds attribute

tpMillisL :: Lens' TimeParts Int Source #

Lens for the tpMillis attribute

Countdown Lenses

countdownLengthL :: Lens' Countdown NominalDiffTime Source #

Lens for the countdownLength attribute

countdownTimerL :: Lens' Countdown Timer Source #

Lens for the countdownTimer attribute

Stopwatch Lenses

stopwatchTimerL :: Lens' Stopwatch Timer Source #

Lens for the stopwatchTimer attribute

stopwatchLapsL :: Lens' Stopwatch [NominalDiffTime] Source #

Lens for the stopwatchLaps attribute

Constructors

newTimer :: Timer Source #

New instance of a Timer

newTimeParts :: TimeParts Source #

New instance of a TimeParts value

newCountdown Source #

Arguments

:: NominalDiffTime	The time length
-> Countdown

New instance of a Countdown

newStopwatch :: Stopwatch Source #

New instance of a stopwatch

Impure Functions

Timer Functions

startTimer Source #

Arguments

:: Timer	The `Timer` being started
-> IO Timer	The modified `Timer`

Starts a Timer

stopTimer Source #

Arguments

:: Timer	The `Timer` being stopped
-> IO Timer	The modified `Timer`

Stops a Timer

timeElapsed Source #

Arguments

:: Timer	The `Timer` being checked
-> IO NominalDiffTime	The amount of time elapsed

Calculates the amount of time elapsed on a Timer

Countdown Functions

startCountdown Source #

Arguments

:: Countdown	The `Countdown` being started
-> IO Countdown	Returns the modified `Countdown`

Starts a Countdown

stopCountdown Source #

Arguments

:: Countdown	The `Countdown` being stopped
-> IO Countdown	Returns the modified `Countdown`

Stops a Countdown

timeRemaining Source #

Arguments

:: Countdown	The `Countdown` being checked
-> IO NominalDiffTime	The amount of time remaining

Calculates the amount of time remaining in a Countdown

countdownIsCompleted Source #

Arguments

:: Countdown	The `Countdown` being checked
-> IO Bool	Returns `True` if the `Countdown` has completed, `False` otherwise

Determines whether or not a Countdown has completed.

Stopwatch Functions

startStopwatch Source #

Arguments

:: Stopwatch	The `Stopwatch` being started
-> IO Stopwatch	Returns the modified `Stopwatch`

Starts a Stopwatch

stopStopwatch Source #

Arguments

:: Stopwatch	The `Stopwatch` being stopped
-> IO Stopwatch	Returns the modified `Stopwatch`

Stops a Stopwatch

newLap Source #

Arguments

:: Stopwatch	The `Stopwatch` being modified
-> IO Stopwatch	Returns the `Stopwatch` being modified

Starts a new lap

currentLap Source #

Arguments

:: Stopwatch	The `Stopwatch` being checked
-> IO NominalDiffTime	Returns the amount of time elapsed in the current lap

Returns the time of the current lap from a Stopwatch

allLaps Source #

Arguments

:: Stopwatch	The `Stopwatch` being checked
-> IO [NominalDiffTime]	Returns the lap times (most recent first)

Returns the lap times for a Stopwatch

totalStopwatchTime Source #

Arguments

:: Stopwatch	The `Stopwatch` being checked
-> IO NominalDiffTime	Returns the total run time

Calculates the total run time of a Stopwatch

Pure Functions

decomposeNDT :: NominalDiffTime -> TimeParts Source #

Converts a NominalDiffTime to a TimeParts value

composeNDT :: TimeParts -> NominalDiffTime Source #

Converts a TimeParts value to a NominalDiffTime

humanNDT :: NominalDiffTime -> String Source #

Converts a NominalDiffTime into a more human-readable format

Timer Functions

timerIsRunning Source #

Arguments

:: Timer	The `Timer` being checked
-> Bool

Determines whether or not a Timer is running

timerIsStarted Source #

Arguments

:: Timer	The `Timer` being checked
-> Bool	`True` if the timer has been started, `False` otherwise

Determines whether or not a Timer has been started (even if it is currently stopped)

startTimerAt Source #

Arguments

:: UTCTime	The current time
-> Timer	The `Timer` being started
-> Timer	The modified `Timer`

Starts a Timer from a given time

stopTimerAt Source #

Arguments

:: UTCTime	The current time
-> Timer	The `Timer` being stopped
-> Timer	The modified `Timer`

Stops a Timer from a given time

timeElapsedAt Source #

Arguments

:: UTCTime	The current time
-> Timer	The `Timer` being checked
-> NominalDiffTime	The amount of time elapsed

Calculates the amount of time elapsed on a Timer from a given time

Countdown Functions

countdownIsRunning Source #

Arguments

:: Countdown	The `Countdown` being checked
-> Bool	`True` if running, `False` otherwise

Determines whether or not a Countdown is running

countdownIsStarted Source #

Arguments

:: Countdown	The `Countdown` being checked
-> Bool	`True` if it has been started, `False` otherwise

Determines whether or not a Countdown has been started (even if subsequently stopped)

startCountdownAt Source #

Arguments

:: UTCTime	The current time
-> Countdown	The `Countdown` being started
-> Countdown	The modified `Countdown`

Starts a Countdown using a given time

stopCountdownAt Source #

Arguments

:: UTCTime	The current time
-> Countdown	The `Countdown` being stopped
-> Countdown	The modified `Countdown`

Stops a Countdown using a given time

timeRemainingAt Source #

Arguments

:: UTCTime	The current time
-> Countdown	The `Countdown` being checked
-> NominalDiffTime	The amount of time remaining

Calculates the amount of time remaining in a Countdown at a given time

countdownIsCompletedAt Source #

Arguments

:: UTCTime	The current time
-> Countdown	The `Countdown` being checked
-> Bool	Returns `True` if the `Countdown` has completed, `False` otherwise.

Determines if a Countdown is completed at a given time

Stopwatch Functions

stopwatchIsRunning Source #

Arguments

:: Stopwatch	The `Stopwatch` being checked
-> Bool	`True` if the `Stopwatch` is running, `False` otherwise

Determines whether or not a Stopwatch is running

stopwatchIsStarted Source #

Arguments

:: Stopwatch	The `Stopwatch` being checked
-> Bool	`True` if started, `False` otherwise

Determines whether or not a stopwatch has been started (even if subsequently stopped)

startStopwatchAt Source #

Arguments

:: UTCTime	The current time
-> Stopwatch	The `Stopwatch` being started
-> Stopwatch	The modified `Stopwatch`

Starts a Stopwatch at a given time

stopStopwatchAt Source #

Arguments

:: UTCTime	The current time
-> Stopwatch	The `Stopwatch` being stopped
-> Stopwatch	The modified `Stopwatch`

Stops a Stopwatch at a given time

newLapAt Source #

Arguments

:: UTCTime	The currebt time
-> Stopwatch	The `Stopwatch` being modified
-> Stopwatch	The modified `Stopwatch`

Starts a new lap at a given time

currentLapAt Source #

Arguments

:: UTCTime	The current time
-> Stopwatch	The `Stopwatch` being checkwd
-> NominalDiffTime	The elapsed time for the current lap

Determines the length of the current lap given a time

allLapsAt Source #

Arguments

:: UTCTime	The current time
-> Stopwatch	The `Stopwatch` being checked
-> [NominalDiffTime]	The lap times (most recent first)

Returns the lap times from a Stopwatch given a time

totalStopwatchTimeAt Source #

Arguments

:: UTCTime	The current time
-> Stopwatch	The `Stopwatch` being checked
-> NominalDiffTime	The total run time

Calculates the total runtime of a Stopwatch given a time