KMonad.Util

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

Time units and utils

data Milliseconds

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

Instances

Enum Milliseconds

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]

Eq Milliseconds

Defined in KMonad.Util

Methods

(==) :: Milliseconds -> Milliseconds -> Bool

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

Integral Milliseconds

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

Num Milliseconds

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

Ord Milliseconds

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

Read Milliseconds

Defined in KMonad.Util

Methods

readsPrec :: Int -> ReadS Milliseconds

readList :: ReadS [Milliseconds]

readPrec :: ReadPrec Milliseconds

readListPrec :: ReadPrec [Milliseconds]

Real Milliseconds

Defined in KMonad.Util

Methods

toRational :: Milliseconds -> Rational

Show Milliseconds

Defined in KMonad.Util

Methods

showsPrec :: Int -> Milliseconds -> ShowS

show :: Milliseconds -> String

showList :: [Milliseconds] -> ShowS

Generic Milliseconds

Defined in KMonad.Util

Associated Types

type Rep Milliseconds :: Type -> Type

Methods

from :: Milliseconds -> Rep Milliseconds x

to :: Rep Milliseconds x -> Milliseconds

Display Milliseconds

Defined in KMonad.Util

Methods

display :: Milliseconds -> Utf8Builder

textDisplay :: Milliseconds -> Text

type Rep Milliseconds

Defined in KMonad.Util

type Rep Milliseconds = D1 (MetaData "Milliseconds" "KMonad.Util" "kmonad-0.4.1-FPseCbFTtIEC38tuwaAvvU" True) (C1 (MetaCons "Milliseconds" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

tDiff

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 ()

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

Embed the action of using an Acquire in a continuation monad

logRethrow

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

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_

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

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_

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