Safe Haskell	None
Language	Haskell2010

Development.IDE.Types.Logger

Description

This is a compatibility module that abstracts over the concrete choice of logging framework so users can plug in whatever framework they want to.

Synopsis

data Priority
- = Telemetry
- | Debug
- | Info
- | Warning
- | Error
data Logger = Logger {
- logPriority :: Priority -> Text -> IO ()
}
logError :: Logger -> Text -> IO ()
logWarning :: Logger -> Text -> IO ()
logInfo :: Logger -> Text -> IO ()
logDebug :: Logger -> Text -> IO ()
logTelemetry :: Logger -> Text -> IO ()
noLogging :: Logger

Documentation

data Priority Source #

Constructors

Telemetry	Events that are useful for gathering user metrics.
Debug	Verbose debug logging.
Info	Useful information in case an error has to be understood.
Warning	These error messages should not occur in a expected usage, and should be investigated.
Error	Such log messages must never occur in expected usage.

Instances

Bounded Priority Source #
Instance details Defined in Development.IDE.Types.Logger Methods minBound :: Priority # maxBound :: Priority #
Enum Priority Source #
Instance details Defined in Development.IDE.Types.Logger Methods succ :: Priority -> Priority # pred :: Priority -> Priority # toEnum :: Int -> Priority # fromEnum :: Priority -> Int # enumFrom :: Priority -> [Priority] # enumFromThen :: Priority -> Priority -> [Priority] # enumFromTo :: Priority -> Priority -> [Priority] # enumFromThenTo :: Priority -> Priority -> Priority -> [Priority] #
Eq Priority Source #
Instance details Defined in Development.IDE.Types.Logger Methods (==) :: Priority -> Priority -> Bool # (/=) :: Priority -> Priority -> Bool #
Ord Priority Source #
Instance details Defined in Development.IDE.Types.Logger Methods compare :: Priority -> Priority -> Ordering # (<) :: Priority -> Priority -> Bool # (<=) :: Priority -> Priority -> Bool # (>) :: Priority -> Priority -> Bool # (>=) :: Priority -> Priority -> Bool # max :: Priority -> Priority -> Priority # min :: Priority -> Priority -> Priority #
Show Priority Source #
Instance details Defined in Development.IDE.Types.Logger Methods showsPrec :: Int -> Priority -> ShowS # show :: Priority -> String # showList :: [Priority] -> ShowS #

data Logger Source #

Note that this is logging actions _of the program_, not of the user. You shouldn't call warning/error if the user has caused an error, only if our code has gone wrong and is itself erroneous (e.g. we threw an exception).

Constructors

Logger
Fields logPriority :: Priority -> Text -> IO ()

logError :: Logger -> Text -> IO () Source #

logWarning :: Logger -> Text -> IO () Source #

logInfo :: Logger -> Text -> IO () Source #

logDebug :: Logger -> Text -> IO () Source #

logTelemetry :: Logger -> Text -> IO () Source #

noLogging :: Logger Source #