Copyright	(c) David Janssen 2019
License	MIT
Maintainer	janssen.dhj@gmail.com
Stability	experimental
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

KMonad.Util

Contents

Time units and utils
Random utility helpers that have no better home
Some helpers to launch background process

Description

Contains code for making it slighly easier to work with time, errors, and Acquire datatypes.

Synopsis

data Milliseconds
unMS :: Milliseconds -> Int
tDiff :: SystemTime -> SystemTime -> Milliseconds
onErr :: (MonadUnliftIO m, Exception e) => m Int -> e -> m ()
using :: Acquire a -> ContT r (RIO e) a
logRethrow :: HasLogFunc e => Text -> SomeException -> RIO e a
withLaunch :: HasLogFunc e => Text -> RIO e a -> (Async a -> RIO e b) -> RIO e b
withLaunch_ :: HasLogFunc e => Text -> RIO e a -> RIO e b -> RIO e b
launch :: HasLogFunc e => Text -> RIO e a -> ContT r (RIO e) (Async a)
launch_ :: HasLogFunc e => Text -> RIO e a -> ContT r (RIO e) ()

Time units and utils

data Milliseconds Source #

Newtype wrapper around Int to add type safety to our time values

Instances

Instances details

Enum Milliseconds Source #
Instance details Defined in KMonad.Util Methods succ :: Milliseconds -> Milliseconds # pred :: Milliseconds -> Milliseconds # toEnum :: Int -> Milliseconds # fromEnum :: Milliseconds -> Int # enumFrom :: Milliseconds -> [Milliseconds] # enumFromThen :: Milliseconds -> Milliseconds -> [Milliseconds] # enumFromTo :: Milliseconds -> Milliseconds -> [Milliseconds] # enumFromThenTo :: Milliseconds -> Milliseconds -> Milliseconds -> [Milliseconds] #
Generic Milliseconds Source #
Instance details Defined in KMonad.Util Associated Types type Rep Milliseconds :: Type -> Type # Methods from :: Milliseconds -> Rep Milliseconds x # to :: Rep Milliseconds x -> Milliseconds #
Num Milliseconds Source #
Instance details Defined in KMonad.Util Methods (+) :: Milliseconds -> Milliseconds -> Milliseconds # (-) :: Milliseconds -> Milliseconds -> Milliseconds # (*) :: Milliseconds -> Milliseconds -> Milliseconds # negate :: Milliseconds -> Milliseconds # abs :: Milliseconds -> Milliseconds # signum :: Milliseconds -> Milliseconds # fromInteger :: Integer -> Milliseconds #
Read Milliseconds Source #
Instance details Defined in KMonad.Util Methods readsPrec :: Int -> ReadS Milliseconds # readList :: ReadS [Milliseconds] # readPrec :: ReadPrec Milliseconds # readListPrec :: ReadPrec [Milliseconds] #
Integral Milliseconds Source #
Instance details Defined in KMonad.Util Methods quot :: Milliseconds -> Milliseconds -> Milliseconds # rem :: Milliseconds -> Milliseconds -> Milliseconds # div :: Milliseconds -> Milliseconds -> Milliseconds # mod :: Milliseconds -> Milliseconds -> Milliseconds # quotRem :: Milliseconds -> Milliseconds -> (Milliseconds, Milliseconds) # divMod :: Milliseconds -> Milliseconds -> (Milliseconds, Milliseconds) # toInteger :: Milliseconds -> Integer #
Real Milliseconds Source #
Instance details Defined in KMonad.Util Methods toRational :: Milliseconds -> Rational #
Show Milliseconds Source #
Instance details Defined in KMonad.Util Methods showsPrec :: Int -> Milliseconds -> ShowS # show :: Milliseconds -> String # showList :: [Milliseconds] -> ShowS #
Eq Milliseconds Source #
Instance details Defined in KMonad.Util Methods (==) :: Milliseconds -> Milliseconds -> Bool # (/=) :: Milliseconds -> Milliseconds -> Bool #
Ord Milliseconds Source #
Instance details Defined in KMonad.Util Methods compare :: Milliseconds -> Milliseconds -> Ordering # (<) :: Milliseconds -> Milliseconds -> Bool # (<=) :: Milliseconds -> Milliseconds -> Bool # (>) :: Milliseconds -> Milliseconds -> Bool # (>=) :: Milliseconds -> Milliseconds -> Bool # max :: Milliseconds -> Milliseconds -> Milliseconds # min :: Milliseconds -> Milliseconds -> Milliseconds #
Display Milliseconds Source #
Instance details Defined in KMonad.Util Methods display :: Milliseconds -> Utf8Builder # textDisplay :: Milliseconds -> Text #
type Rep Milliseconds Source #
Instance details Defined in KMonad.Util type Rep Milliseconds = D1 ('MetaData "Milliseconds" "KMonad.Util" "kmonad-0.4.2-inplace" 'True) (C1 ('MetaCons "Milliseconds" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

unMS :: Milliseconds -> Int Source #

tDiff Source #

Arguments

:: SystemTime	The earlier timepoint
-> SystemTime	The later timepoint
-> Milliseconds	The time in milliseconds between the two

Calculate how much time has elapsed between 2 time points

Random utility helpers that have no better home

onErr :: (MonadUnliftIO m, Exception e) => m Int -> e -> m () Source #

A helper function that helps to throw errors when a return code is -1. Easiest when used as infix like this:

someFFIcall `onErr` MyCallFailedError someData

using :: Acquire a -> ContT r (RIO e) a Source #

Embed the action of using an Acquire in a continuation monad

logRethrow Source #

Arguments

:: HasLogFunc e
=> Text
-> SomeException	The error to throw
-> RIO e a

Log an error message and then rethrow the error

Particularly useful as a suffix using catch. i.e.

doSomething `catch` logRethrow "I caught something"

Some helpers to launch background process

withLaunch Source #

Arguments

:: HasLogFunc e
=> Text	The name of this process (for logging)
-> RIO e a	The action to repeat forever
-> (Async a -> RIO e b)	The foreground action to run
-> RIO e b	The resulting action

Launch a process that repeats an action indefinitely. If an error ever occurs, print it and rethrow it. Ensure the process is cleaned up upon error and/or shutdown.

withLaunch_ Source #

Arguments

:: HasLogFunc e
=> Text	The name of this process (for logging)
-> RIO e a	The action to repeat forever
-> RIO e b	The foreground action to run
-> RIO e b	The resulting action

Like withLaunch, but without ever needing access to the async process

launch Source #

Arguments

:: HasLogFunc e
=> Text	The name of this process (for logging)
-> RIO e a	The action to repeat forever
-> ContT r (RIO e) (Async a)

Like withLaunch, but in the ContT monad

launch_ Source #

Arguments

:: HasLogFunc e
=> Text	The name of this process (for logging)
-> RIO e a	The action to repeat forever
-> ContT r (RIO e) ()

Like withLaunch_, but in the ContT monad