Safe Haskell	None
Language	GHC2021

Unclog.Common

Contents

commonly used types
- types that are lifted by template haskell
channels for publish / subscribe

Synopsis

data LogEntry = MkLogEntry {
- level :: !LogLevel
- timestamp :: !Time
- location :: !Location
- payload :: !StrictByteString
}
data LogLevel
- = Debug
- | Info
- | Warn
- | Fatal
data Location = MkLocation {
- locpkg :: !Text
- locmod :: !Text
- locpos :: !Position
}
data Position = MkPosition {
- posLeft :: !Int
- posRight :: !Int
}
newtype PLogChan = MkPLogChan {
- unPLogChan :: TChan LogEntry
}
newtype SLogChan = MkSLogChan {
- unSLogChan :: TChan LogEntry
}

commonly used types

data LogEntry Source #

the datatype to communicate between a log source and a logging backend

Constructors

MkLogEntry
Fields level :: !LogLevel the log level timestamp :: !Time the time at which the log entry was emitted location :: !Location payload :: !StrictByteString the payload, this is the unstructure part of the log, converting from the structured to the unstructured version is the task of the logging frontend

Instances

Instances details

Generic LogEntry Source #

Instance details

Defined in Unclog.Common

Associated Types

type Rep LogEntry

Instance details

Defined in Unclog.Common

type Rep LogEntry = D1 ('MetaData "LogEntry" "Unclog.Common" "unclogging-0.1.0.1-inplace" 'False) (C1 ('MetaCons "MkLogEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "level") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 LogLevel) :*: S1 ('MetaSel ('Just "timestamp") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Time)) :*: (S1 ('MetaSel ('Just "location") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Location) :*: S1 ('MetaSel ('Just "payload") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 StrictByteString))))

Methods

from :: LogEntry -> Rep LogEntry x #

to :: Rep LogEntry x -> LogEntry #

Show LogEntry Source #

Instance details

Defined in Unclog.Common

Methods

showsPrec :: Int -> LogEntry -> ShowS #

show :: LogEntry -> String #

showList :: [LogEntry] -> ShowS #

Eq LogEntry Source #

Instance details

Defined in Unclog.Common

Methods

(==) :: LogEntry -> LogEntry -> Bool #

(/=) :: LogEntry -> LogEntry -> Bool #

Ord LogEntry Source #

Instance details

Defined in Unclog.Common

Methods

compare :: LogEntry -> LogEntry -> Ordering #

(<) :: LogEntry -> LogEntry -> Bool #

(<=) :: LogEntry -> LogEntry -> Bool #

(>) :: LogEntry -> LogEntry -> Bool #

(>=) :: LogEntry -> LogEntry -> Bool #

max :: LogEntry -> LogEntry -> LogEntry #

min :: LogEntry -> LogEntry -> LogEntry #

type Rep LogEntry Source #

Instance details

Defined in Unclog.Common

type Rep LogEntry = D1 ('MetaData "LogEntry" "Unclog.Common" "unclogging-0.1.0.1-inplace" 'False) (C1 ('MetaCons "MkLogEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "level") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 LogLevel) :*: S1 ('MetaSel ('Just "timestamp") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Time)) :*: (S1 ('MetaSel ('Just "location") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Location) :*: S1 ('MetaSel ('Just "payload") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 StrictByteString))))

types that are lifted by template haskell

data LogLevel Source #

a loglevel

Constructors

Debug
Info
Warn
Fatal

Instances

Instances details

Generic LogLevel Source #

Instance details

Defined in Unclog.Common

Associated Types

type Rep LogLevel
Instance details Defined in Unclog.Common type Rep LogLevel = D1 ('MetaData "LogLevel" "Unclog.Common" "unclogging-0.1.0.1-inplace" 'False) ((C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Warn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fatal" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: LogLevel -> Rep LogLevel x #

to :: Rep LogLevel x -> LogLevel #

Show LogLevel Source #

Instance details

Defined in Unclog.Common

Methods

showsPrec :: Int -> LogLevel -> ShowS #

show :: LogLevel -> String #

showList :: [LogLevel] -> ShowS #

Eq LogLevel Source #

Instance details

Defined in Unclog.Common

Methods

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

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

Ord LogLevel Source #

Instance details

Defined in Unclog.Common

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 #

Lift LogLevel Source #

Instance details

Defined in Unclog.Common

Methods

lift :: Quote m => LogLevel -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => LogLevel -> Code m LogLevel #

type Rep LogLevel Source #

Instance details

Defined in Unclog.Common

type Rep LogLevel = D1 ('MetaData "LogLevel" "Unclog.Common" "unclogging-0.1.0.1-inplace" 'False) ((C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Warn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fatal" 'PrefixI 'False) (U1 :: Type -> Type)))

data Location Source #

the code location at which the log entry was generated

Constructors

MkLocation
Fields locpkg :: !Text the package in which the log entry was generated locmod :: !Text the module in which the log entry was generated locpos :: !Position the position at which the log entry was generated

Instances

Instances details

Generic Location Source #

Instance details

Defined in Unclog.Common

Associated Types

type Rep Location

Instance details

Defined in Unclog.Common

type Rep Location = D1 ('MetaData "Location" "Unclog.Common" "unclogging-0.1.0.1-inplace" 'False) (C1 ('MetaCons "MkLocation" 'PrefixI 'True) (S1 ('MetaSel ('Just "locpkg") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "locmod") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "locpos") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Position))))

Methods

from :: Location -> Rep Location x #

to :: Rep Location x -> Location #

Show Location Source #

Instance details

Defined in Unclog.Common

Methods

showsPrec :: Int -> Location -> ShowS #

show :: Location -> String #

showList :: [Location] -> ShowS #

Eq Location Source #

Instance details

Defined in Unclog.Common

Methods

(==) :: Location -> Location -> Bool #

(/=) :: Location -> Location -> Bool #

Ord Location Source #

Instance details

Defined in Unclog.Common

Methods

compare :: Location -> Location -> Ordering #

(<) :: Location -> Location -> Bool #

(<=) :: Location -> Location -> Bool #

(>) :: Location -> Location -> Bool #

(>=) :: Location -> Location -> Bool #

max :: Location -> Location -> Location #

min :: Location -> Location -> Location #

Lift Location Source #

Instance details

Defined in Unclog.Common

Methods

lift :: Quote m => Location -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Location -> Code m Location #

type Rep Location Source #

Instance details

Defined in Unclog.Common

type Rep Location = D1 ('MetaData "Location" "Unclog.Common" "unclogging-0.1.0.1-inplace" 'False) (C1 ('MetaCons "MkLocation" 'PrefixI 'True) (S1 ('MetaSel ('Just "locpkg") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "locmod") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "locpos") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Position))))

data Position Source #

a source code position

Constructors

MkPosition
Fields posLeft :: !Int posRight :: !Int

Instances

Instances details

Generic Position Source #

Instance details

Defined in Unclog.Common

Associated Types

type Rep Position
Instance details Defined in Unclog.Common type Rep Position = D1 ('MetaData "Position" "Unclog.Common" "unclogging-0.1.0.1-inplace" 'False) (C1 ('MetaCons "MkPosition" 'PrefixI 'True) (S1 ('MetaSel ('Just "posLeft") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "posRight") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int)))