Network.Mattermost.Types.Base

These are the fundamental types that are used for building everything else. Specifically, these types are used by the Network.Mattermost.Types.Internal, but are not subject to the cautions that as associated with the latter.

Documentation

type Hostname = Text

type Port = Int

type Logger = LogEvent -> IO ()

A Logger is any function which responds to log events:

data LogEvent

If there is a Logger in the ConnectionData struct, it will be sporadically called with values of type LogEvent.

Constructors

LogEvent

Fields

• logFunction :: String
• logEventType :: LogEventType

Instances

Eq LogEvent

Defined in Network.Mattermost.Types.Base

Methods

(==) :: LogEvent -> LogEvent -> Bool

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

Show LogEvent

Defined in Network.Mattermost.Types.Base

Methods

showsPrec :: Int -> LogEvent -> ShowS

show :: LogEvent -> String

showList :: [LogEvent] -> ShowS

data LogEventType

A LogEventType describes the particular event that happened

Constructors

HttpRequest RequestMethod String (Maybe String)

HttpResponse Int String (Maybe String)

WebSocketRequest Value

WebSocketResponse (Either String String)

Left means we got an exception trying to parse the response; Right means we succeeded and here it is.

WebSocketPing

WebSocketPong

Instances

Eq LogEventType

Defined in Network.Mattermost.Types.Base

Methods

(==) :: LogEventType -> LogEventType -> Bool

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

Show LogEventType

Defined in Network.Mattermost.Types.Base

Methods

showsPrec :: Int -> LogEventType -> ShowS

show :: LogEventType -> String

showList :: [LogEventType] -> ShowS

newtype ServerTime

The time as provided by the Server. This is a wrapper designed to warn against naive comparisons to local times: the server's time and local times are not necessarily synchronized.

Constructors

ServerTime

Fields

• withServerTime :: UTCTime

Instances

Eq ServerTime

Defined in Network.Mattermost.Types.Base

Methods

(==) :: ServerTime -> ServerTime -> Bool

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

Ord ServerTime

Defined in Network.Mattermost.Types.Base

Methods

compare :: ServerTime -> ServerTime -> Ordering

(<) :: ServerTime -> ServerTime -> Bool

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

(>) :: ServerTime -> ServerTime -> Bool

(>=) :: ServerTime -> ServerTime -> Bool

max :: ServerTime -> ServerTime -> ServerTime

min :: ServerTime -> ServerTime -> ServerTime

Read ServerTime

Defined in Network.Mattermost.Types.Base

Methods

readsPrec :: Int -> ReadS ServerTime

readList :: ReadS [ServerTime]

readPrec :: ReadPrec ServerTime

readListPrec :: ReadPrec [ServerTime]

Show ServerTime

Defined in Network.Mattermost.Types.Base

Methods

showsPrec :: Int -> ServerTime -> ShowS

show :: ServerTime -> String

showList :: [ServerTime] -> ShowS