ELynx.Tools.Logger

Creation date: Fri Sep 6 14:43:19 2019.

Documentation

data Verbosity

Verbosity levels.

Constructors

Quiet

Warn

Info

Debug

Instances

Bounded Verbosity

Defined in ELynx.Tools.Logger

Methods

minBound :: Verbosity

maxBound :: Verbosity

Enum Verbosity

Defined in ELynx.Tools.Logger

Methods

succ :: Verbosity -> Verbosity

pred :: Verbosity -> Verbosity

toEnum :: Int -> Verbosity

fromEnum :: Verbosity -> Int

enumFrom :: Verbosity -> [Verbosity]

enumFromThen :: Verbosity -> Verbosity -> [Verbosity]

enumFromTo :: Verbosity -> Verbosity -> [Verbosity]

enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity]

Eq Verbosity

Defined in ELynx.Tools.Logger

Methods

(==) :: Verbosity -> Verbosity -> Bool

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

Ord Verbosity

Defined in ELynx.Tools.Logger

Methods

compare :: Verbosity -> Verbosity -> Ordering

(<) :: Verbosity -> Verbosity -> Bool

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

(>) :: Verbosity -> Verbosity -> Bool

(>=) :: Verbosity -> Verbosity -> Bool

max :: Verbosity -> Verbosity -> Verbosity

min :: Verbosity -> Verbosity -> Verbosity

Read Verbosity

Defined in ELynx.Tools.Logger

Methods

readsPrec :: Int -> ReadS Verbosity

readList :: ReadS [Verbosity]

readPrec :: ReadPrec Verbosity

readListPrec :: ReadPrec [Verbosity]

Show Verbosity

Defined in ELynx.Tools.Logger

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

Generic Verbosity

Defined in ELynx.Tools.Logger

Associated Types

type Rep Verbosity :: Type -> Type

Methods

from :: Verbosity -> Rep Verbosity x

to :: Rep Verbosity x -> Verbosity

ToJSON Verbosity

Defined in ELynx.Tools.Logger

Methods

toJSON :: Verbosity -> Value

toEncoding :: Verbosity -> Encoding

toJSONList :: [Verbosity] -> Value

toEncodingList :: [Verbosity] -> Encoding

FromJSON Verbosity

Defined in ELynx.Tools.Logger

Methods

parseJSON :: Value -> Parser Verbosity

parseJSONList :: Value -> Parser [Verbosity]

type Rep Verbosity

Defined in ELynx.Tools.Logger

type Rep Verbosity = D1 ('MetaData "Verbosity" "ELynx.Tools.Logger" "elynx-tools-0.6.1.0-AWjKNFEpQDhHVmYwSmmoU2" 'False) ((C1 ('MetaCons "Quiet" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Warn" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type)))

class HasLock e where

Types with an output lock for concurrent output.

Methods

getLock :: e -> MVar ()

Instances

HasLock (Environment a)

Defined in ELynx.Tools.Environment

Methods

getLock :: Environment a -> MVar ()

class HasLogHandles e where

Types with logging information.

Methods

getLogHandles :: e -> [Handle]

Instances

HasLogHandles (Environment a)

Defined in ELynx.Tools.Environment

Methods

getLogHandles :: Environment a -> [Handle]

class HasStartingTime s where

Types with starting time.

Methods

getStartingTime :: s -> UTCTime

Instances

HasStartingTime (Environment a)

Defined in ELynx.Tools.Environment

Methods

getStartingTime :: Environment a -> UTCTime

class HasVerbosity s where

Types with verbosity.

Methods

getVerbosity :: s -> Verbosity

Instances

HasVerbosity (Environment a)

Defined in ELynx.Tools.Environment

Methods

getVerbosity :: Environment a -> Verbosity

type Logger e a = ReaderT e IO a

Reader transformer used for logging to a file and to standard output.

logOutB

Arguments

:: (HasLogHandles e, HasLock e)

=> ByteString

Prefix.

-> ByteString

Message.

-> Logger e ()

Write to standard output and maybe to log file.

logDebugB :: (HasLock e, HasLogHandles e, HasVerbosity e) => ByteString -> Logger e ()

Log debug message.

logDebugS :: (HasLock e, HasLogHandles e, HasVerbosity e) => String -> Logger e ()

Log debug message.

logWarnB :: (HasLock e, HasLogHandles e, HasVerbosity e) => ByteString -> Logger e ()

Log warning message.

logWarnS :: (HasLock e, HasLogHandles e, HasVerbosity e) => String -> Logger e ()

Log warning message.

logInfoB :: (HasLock e, HasLogHandles e, HasVerbosity e) => ByteString -> Logger e ()

Log info message.

logInfoS :: (HasLock e, HasLogHandles e, HasVerbosity e) => String -> Logger e ()

Log info message.

logHeader :: [String]

A short header to be used in executables. unlines doesn't work here because it adds an additional newline at the end.

logInfoHeader :: (HasLock e, HasLogHandles e, HasStartingTime e, HasVerbosity e) => String -> [String] -> Logger e ()

Log header.

logInfoFooter :: (HasLock e, HasLogHandles e, HasStartingTime e, HasVerbosity e) => Logger e ()

Log footer.

logInfoNewSection :: (HasLock e, HasLogHandles e, HasVerbosity e) => String -> Logger e ()

Unified way of creating a new section in the log.