Game.GoreAndAsh.Logging.API

Module that contains monadic and arrow API of logging module.

Documentation

class MonadIO m => LoggingMonad m where

Low level API for module

Methods

putMsgM :: LoggingLevel -> Text -> m ()

Put message to the console.

putMsgLnM :: LoggingLevel -> Text -> m ()

Put message and new line to the console.

loggingSetHandle :: Handle -> m ()

Setting current logging file handler

loggingSetFilter :: LoggingLevel -> [LoggingSink] -> m ()

Setting allowed sinks for given logging level.

By default all messages are passed into file and console.

Instances

(MonadIO (mt m), LoggingMonad m, MonadTrans mt) => LoggingMonad (mt m)

MonadIO m => LoggingMonad (LoggingT s m)

loggingSetFile

Arguments

:: LoggingMonad m

=> FilePath

Path to logging file

-> Bool

If False, rewrites contents of the file, if True opens in append mode

-> m ()

Helper to set logging file as local path

Arrow API

logA :: LoggingMonad m => LoggingLevel -> GameWire m Text ()

Put message to console on every frame without newline

logALn :: LoggingMonad m => LoggingLevel -> GameWire m Text ()

Put message to console on every frame

logE :: LoggingMonad m => LoggingLevel -> GameWire m (Event Text) (Event ())

Put message to console on event without newline

logELn :: LoggingMonad m => LoggingLevel -> GameWire m (Event Text) (Event ())

Put message to console on event

Every frame

logDebugA :: LoggingMonad m => GameWire m Text ()

Put info msg to console

logInfoA :: LoggingMonad m => GameWire m Text ()

Put info msg to console

logWarnA :: LoggingMonad m => GameWire m Text ()

Put warn msg to console

logErrorA :: LoggingMonad m => GameWire m Text ()

Put error msg to console

Event based

logDebugE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put info msg to console on event

logInfoE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put info msg to console on event

logWarnE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put warn msg to console on event

logErrorE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put error msg to console on event

Event tracing

traceEvent :: LoggingMonad m => (a -> Text) -> GameWire m (Event a) (Event ())

Prints event with given function

traceEventShow :: (TextShow a, LoggingMonad m) => GameWire m (Event a) (Event ())

Prints event