Safe Haskell	None
Language	GHC2021

Shrun.Logging.Types

Contents

Basic Types
Console Logs
File Logs

Description

This module provides the Log type and associated functions.

Synopsis

data Log = MkLog {
- cmd :: Maybe CommandP1
- msg :: UnlinedText
- lvl :: LogLevel
- mode :: LogMode
}
data LogMode
- = LogModeSet
- | LogModeAppend
- | LogModeFinish
data LogLevel
- = LevelCommand
- | LevelFinished
- | LevelTimer
- | LevelSuccess
- | LevelWarn
- | LevelError
- | LevelFatal
data ConsoleLog
data LogRegion r
- = LogRegion LogMode r ConsoleLog
- | LogNoRegion ConsoleLog
data FileLog

Basic Types

data Log Source #

Captures the relevant information concerning a specific log (i.e. command, text, level, and mode).

Constructors

MkLog
Fields cmd :: Maybe CommandP1 Optional command that produced this log. msg :: UnlinedText The `Text` for a given log. lvl :: LogLevel The `LogLevel` for a given log. mode :: LogMode The `LogMode` for a given log.

Instances

Instances details

Show Log Source #
Instance details Defined in Shrun.Logging.Types Methods showsPrec :: Int -> Log -> ShowS # show :: Log -> String # showList :: [Log] -> ShowS #
(k ~ A_Lens, a ~ Maybe CommandP1, b ~ Maybe CommandP1) => LabelOptic "cmd" k Log Log a b Source #
Instance details Defined in Shrun.Logging.Types Methods labelOptic :: Optic k NoIx Log Log a b Source #
(k ~ A_Lens, a ~ LogLevel, b ~ LogLevel) => LabelOptic "lvl" k Log Log a b Source #
Instance details Defined in Shrun.Logging.Types Methods labelOptic :: Optic k NoIx Log Log a b Source #
(k ~ A_Lens, a ~ LogMode, b ~ LogMode) => LabelOptic "mode" k Log Log a b Source #
Instance details Defined in Shrun.Logging.Types Methods labelOptic :: Optic k NoIx Log Log a b Source #
(k ~ A_Lens, a ~ UnlinedText, b ~ UnlinedText) => LabelOptic "msg" k Log Log a b Source #
Instance details Defined in Shrun.Logging.Types Methods labelOptic :: Optic k NoIx Log Log a b Source #

data LogMode Source #

Determines the logging behavior. This option only affects console logs; File logs are unaffected.

Constructors

LogModeSet	Sets the logging region to this log.
LogModeAppend	Appends the log to the logging region.
LogModeFinish	Closes the logging region, finishing with the log.

Instances

Instances details

Bounded LogMode Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods minBound :: LogMode # maxBound :: LogMode #
Enum LogMode Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods succ :: LogMode -> LogMode # pred :: LogMode -> LogMode # toEnum :: Int -> LogMode # fromEnum :: LogMode -> Int # enumFrom :: LogMode -> [LogMode] # enumFromThen :: LogMode -> LogMode -> [LogMode] # enumFromTo :: LogMode -> LogMode -> [LogMode] # enumFromThenTo :: LogMode -> LogMode -> LogMode -> [LogMode] #
Show LogMode Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods showsPrec :: Int -> LogMode -> ShowS # show :: LogMode -> String # showList :: [LogMode] -> ShowS #
Eq LogMode Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods (==) :: LogMode -> LogMode -> Bool # (/=) :: LogMode -> LogMode -> Bool #

data LogLevel Source #

Determines the logging level.

Constructors

LevelCommand
LevelFinished
LevelTimer
LevelSuccess
LevelWarn
LevelError
LevelFatal

Instances

Instances details

Bounded LogLevel Source #
Instance details Defined in Shrun.Logging.Types Methods minBound :: LogLevel # maxBound :: LogLevel #
Enum LogLevel Source #
Instance details Defined in Shrun.Logging.Types 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] #
Show LogLevel Source #
Instance details Defined in Shrun.Logging.Types Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Eq LogLevel Source #
Instance details Defined in Shrun.Logging.Types Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #

Console Logs

data ConsoleLog Source #

ConsoleLog is a textual representation of a given log after it has been formatted.

Instances

Instances details

Show ConsoleLog Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods showsPrec :: Int -> ConsoleLog -> ShowS # show :: ConsoleLog -> String # showList :: [ConsoleLog] -> ShowS #
Eq ConsoleLog Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods (==) :: ConsoleLog -> ConsoleLog -> Bool # (/=) :: ConsoleLog -> ConsoleLog -> Bool #
(k ~ A_Getter, a ~ Text, b ~ Text) => LabelOptic "unConsoleLog" k ConsoleLog ConsoleLog a b Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods labelOptic :: Optic k NoIx ConsoleLog ConsoleLog a b Source #

data LogRegion r Source #

ConsoleLog with possible region.

Constructors

LogRegion LogMode r ConsoleLog	Log with region.
LogNoRegion ConsoleLog	Log without region.

File Logs

data FileLog Source #

FileLog is a textual representation of a given log after it has been formatted. No coloring is included, but we include the prefix (e.g. Warn) along with a timestamp.

Instances

Instances details

Show FileLog Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods showsPrec :: Int -> FileLog -> ShowS # show :: FileLog -> String # showList :: [FileLog] -> ShowS #
Eq FileLog Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods (==) :: FileLog -> FileLog -> Bool # (/=) :: FileLog -> FileLog -> Bool #
(k ~ A_Getter, a ~ Text, b ~ Text) => LabelOptic "unFileLog" k FileLog FileLog a b Source #
Instance details Defined in Shrun.Logging.Types.Internal Methods labelOptic :: Optic k NoIx FileLog FileLog a b Source #