log package:rio

Log a debug level message with no source.

logDebugS :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogSource -> Utf8Builder -> m ()

rio RIO

Log a debug level message with the given source.

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

rio RIO

Log an error level message with no source.

logErrorS :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogSource -> Utf8Builder -> m ()

rio RIO

Log an error level message with the given source.

logFuncAccentColorsL :: HasLogFunc env => SimpleGetter env (Int -> Utf8Builder)

rio RIO

What accent colors, indexed by Int, is the log func configured to use? Intended for use by code which wants to optionally add additional color to its log messages.

logFuncL :: HasLogFunc env => Lens' env LogFunc

rio RIO

logFuncLogLevelColorsL :: HasLogFunc env => SimpleGetter env (LogLevel -> Utf8Builder)

rio RIO

What color is the log func configured to use for each LogLevel? Intended for use by code which wants to optionally add additional color to its log messages.

logFuncSecondaryColorL :: HasLogFunc env => SimpleGetter env Utf8Builder

rio RIO

What color is the log func configured to use for secondary content? Intended for use by code which wants to optionally add additional color to its log messages.

logFuncUseColorL :: HasLogFunc env => SimpleGetter env Bool

rio RIO

Is the log func configured to use color output? Intended for use by code which wants to optionally add additional color to its log messages.

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

rio RIO

Generic, basic function for creating other logging functions.

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

rio RIO

Log an info level message with no source.

logInfoS :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogSource -> Utf8Builder -> m ()

rio RIO

Log an info level message with the given source.

logOptionsHandle :: MonadIO m => Handle -> Bool -> m LogOptions

rio RIO

Create a LogOptions value from the given Handle and whether to perform verbose logging or not. Individiual settings can be overridden using appropriate set functions. Logging output is guaranteed to be non-interleaved only for a UTF-8 Handle in a multi-thread environment. When Verbose Flag is True, the following happens:

setLogVerboseFormat is called with True
setLogUseColor is called with True (except on Windows)
setLogUseLoc is called with True
setLogUseTime is called with True
setLogMinLevel is called with Debug log level

logOptionsMemory :: MonadIO m => m (IORef Builder, LogOptions)

rio RIO

Create a LogOptions value which will store its data in memory. This is primarily intended for testing purposes. This will return both a LogOptions value and an IORef containing the resulting Builder value. This will default to non-verbose settings and assume there is a terminal attached. These assumptions can be overridden using the appropriate set functions.

logOther :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => Text -> Utf8Builder -> m ()

rio RIO

Log a message with the specified textual level and no source.

logOtherS :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => Text -> LogSource -> Utf8Builder -> m ()

rio RIO

Log a message with the specified textual level and the given source.

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

rio RIO

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. Note that not all LogFunc implementations will support sticky messages as described. However, the withLogFunc implementation provided by this module does.

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

rio RIO

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.

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

rio RIO

Log a warn level message with no source.

logWarnS :: (MonadIO m, MonadReader env m, HasLogFunc env, HasCallStack) => LogSource -> Utf8Builder -> m ()

rio RIO

Log a warn level message with the given source.

logBase :: Floating a => a -> a -> a

rio RIO.Prelude

data LogFunc

rio RIO

A logging function, wrapped in a newtype for better error messages. An implementation may choose any behavior of this value it wishes, including printing to standard output or no action at all.

data LogLevel

rio RIO

The log level of a message.

data LogOptions

rio RIO

Configuration for how to create a LogFunc. Intended to be used with the withLogFunc function.