RIO.Logger

Documentation

data LogLevel

Constructors

LevelDebug

LevelInfo

LevelWarn

LevelError

LevelOther !Text

Instances

Eq LogLevel

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Ord LogLevel

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

(<=) :: LogLevel -> LogLevel -> Bool

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Read LogLevel

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

type LogSource = Text

type LogStr = DisplayBuilder

type LogFunc = CallStack -> LogSource -> LogLevel -> LogStr -> IO ()

class HasLogFunc env where

Minimal complete definition

logFuncL

Methods

logFuncL :: SimpleGetter env LogFunc

Instances

HasLogFunc NoLogging

Methods

logFuncL :: SimpleGetter NoLogging LogFunc

logGeneric :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogSource -> LogLevel -> LogStr -> m ()

logDebug :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogStr -> m ()

logInfo :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogStr -> m ()

logWarn :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogStr -> m ()

logError :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogStr -> m ()

logOther

Arguments

:: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack)

=> Text

level

-> LogStr

-> m ()

logSticky :: (MonadIO m, HasCallStack, MonadReader env m, HasLogFunc env) => LogStr -> m ()

Write a "sticky" line to the terminal. Any subsequent lines will overwrite this one, and that same line will be repeated below again. In other words, the line sticks at the bottom of the output forever. Running this function again will replace the sticky line with a new sticky line. When you want to get rid of the sticky line, run logStickyDone.

logStickyDone :: (MonadIO m, HasCallStack, MonadReader env m, HasLogFunc env) => LogStr -> m ()

This will print out the given message with a newline and disable any further stickiness of the line until a new call to logSticky happens.

It might be better at some point to have a runSticky function that encompasses the logSticky->logStickyDone pairing.

runNoLogging :: MonadIO m => ReaderT NoLogging m a -> m a

data NoLogging

Constructors

NoLogging

Instances

HasLogFunc NoLogging

Methods

logFuncL :: SimpleGetter NoLogging LogFunc

withStickyLogger :: MonadIO m => LogOptions -> (LogFunc -> m a) -> m a

data LogOptions

Constructors

LogOptions

Fields

• logMinLevel :: !LogLevel
• logVerboseFormat :: !Bool
• logTerminal :: !Bool
• logUseTime :: !Bool
• logUseColor :: !Bool
• logUseUnicode :: !Bool