Test.DocTest.Internal.Logging

Documentation

type DebugLogger = String -> IO ()

Convenience type alias - not used in this module, but sprinkled across the project.

noLogger :: DebugLogger

Discards any log message

data LogLevel

Constructors

Debug

Intended for debug runs

Verbose

Intended for debug runs, but without flooding the user with internal messages

Info

Default log level - print messages user is likely wanting to see

Warning

Only print warnings

Error

Only print errors

Instances

Bounded LogLevel

Defined in Test.DocTest.Internal.Logging

Methods

minBound :: LogLevel

maxBound :: LogLevel

Enum LogLevel

Defined in Test.DocTest.Internal.Logging

Methods

succ :: LogLevel -> LogLevel

pred :: LogLevel -> LogLevel

toEnum :: Int -> LogLevel

fromEnum :: LogLevel -> Int

enumFrom :: LogLevel -> [LogLevel]

enumFromThen :: LogLevel -> LogLevel -> [LogLevel]

enumFromTo :: LogLevel -> LogLevel -> [LogLevel]

enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel]

Generic LogLevel

Defined in Test.DocTest.Internal.Logging

Associated Types

type Rep LogLevel :: Type -> Type

Methods

from :: LogLevel -> Rep LogLevel x

to :: Rep LogLevel x -> LogLevel

Show LogLevel

Defined in Test.DocTest.Internal.Logging

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

NFData LogLevel

Defined in Test.DocTest.Internal.Logging

Methods

rnf :: LogLevel -> ()

Eq LogLevel

Defined in Test.DocTest.Internal.Logging

Methods

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

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

Ord LogLevel

Defined in Test.DocTest.Internal.Logging

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

type Rep LogLevel

Defined in Test.DocTest.Internal.Logging

type Rep LogLevel = D1 ('MetaData "LogLevel" "Test.DocTest.Internal.Logging" "doctest-parallel-0.3.1-inplace" 'False) ((C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Verbose" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Warning" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type))))

parseLogLevel :: String -> Maybe LogLevel

Case insensitive

>>> parseLogLevel "Info"
Just Info
>>> parseLogLevel "info"
Just Info
>>> parseLogLevel "errox"
Nothing

showJustifiedLogLevel :: LogLevel -> String

Pretty print a LogLevel in a justified manner, i.e., all outputs take the same amount of characters to display.

>>> showJustifiedLogLevel Debug
"Debug  "
>>> showJustifiedLogLevel Verbose
"Verbose"
>>> showJustifiedLogLevel Info
"Info   "
>>> showJustifiedLogLevel Warning
"Warning"
>>> showJustifiedLogLevel Error
"Error  "

justifyLeft :: Int -> a -> [a] -> [a]

Justify a list with a custom fill symbol

>>> justifyLeft 10 'x' "foo"
"fooxxxxxxx"
>>> justifyLeft 3 'x' "foo"
"foo"
>>> justifyLeft 2 'x' "foo"
"foo"

formatLog :: ThreadId -> LogLevel -> String -> String

Prettily format a log message

threadId <- myThreadId
formatLog Debug threadId "some debug message"

"[DEBUG ] [ThreadId 1277462] some debug message"

formatLogHere :: LogLevel -> String -> IO String

Like formatLog, but instantiates the thread argument with the current ThreadId

formatLogHere Debug "some debug message"

"[DEBUG ] [ThreadId 1440849] some debug message"

shouldLog :: (?verbosity :: LogLevel) => LogLevel -> Bool

Should a message be printed? For a given verbosity level and message log level.

log :: (?verbosity :: LogLevel) => LogLevel -> String -> IO ()

Basic logging function. Uses formatLogHere. Is not thread-safe.