Safe Haskell	None
Language	Haskell2010

Network.Mattermost.Types.Internal

Description

The types defined in this module are exported to facilitate efforts such as QuickCheck and other instrospection efforts, but users are advised to avoid using these types wherever possible: they can be used in a manner that would cause significant disruption and may be subject to change without being reflected in the mattermost-api version.

Synopsis

data Token = Token String
getTokenString :: Token -> String
data AutoClose
- = No
- | Yes
autoCloseToHeader :: AutoClose -> [Header]
data MMConn = MMConn {
- fromMMConn :: Connection
- connConnected :: IORef Bool
}
closeMMConn :: MMConn -> IO ()
newMMConn :: Connection -> IO MMConn
isConnected :: MMConn -> IO Bool
maxLineLength :: Int
dropTrailingChar :: ByteString -> ByteString
data ConnectionType
- = ConnectHTTPS Bool
- | ConnectHTTP
data ConnectionData = ConnectionData {
- cdHostname :: Hostname
- cdPort :: Port
- cdUrlPath :: Text
- cdAutoClose :: AutoClose
- cdConnectionPool :: Pool MMConn
- cdConnectionCtx :: ConnectionContext
- cdToken :: Maybe Token
- cdLogger :: Maybe Logger
- cdConnectionType :: ConnectionType
}

Documentation

data Token Source #

Constructors

Token String

Instances

Eq Token Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Ord Token Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods compare :: Token -> Token -> Ordering # (<) :: Token -> Token -> Bool # (<=) :: Token -> Token -> Bool # (>) :: Token -> Token -> Bool # (>=) :: Token -> Token -> Bool # max :: Token -> Token -> Token # min :: Token -> Token -> Token #
Read Token Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods readsPrec :: Int -> ReadS Token # readList :: ReadS [Token] # readPrec :: ReadPrec Token # readListPrec :: ReadPrec [Token] #
Show Token Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #

getTokenString :: Token -> String Source #

data AutoClose Source #

Constructors

No
Yes

Instances

Eq AutoClose Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods (==) :: AutoClose -> AutoClose -> Bool # (/=) :: AutoClose -> AutoClose -> Bool #
Ord AutoClose Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods compare :: AutoClose -> AutoClose -> Ordering # (<) :: AutoClose -> AutoClose -> Bool # (<=) :: AutoClose -> AutoClose -> Bool # (>) :: AutoClose -> AutoClose -> Bool # (>=) :: AutoClose -> AutoClose -> Bool # max :: AutoClose -> AutoClose -> AutoClose # min :: AutoClose -> AutoClose -> AutoClose #
Read AutoClose Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods readsPrec :: Int -> ReadS AutoClose # readList :: ReadS [AutoClose] # readPrec :: ReadPrec AutoClose # readListPrec :: ReadPrec [AutoClose] #
Show AutoClose Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods showsPrec :: Int -> AutoClose -> ShowS # show :: AutoClose -> String # showList :: [AutoClose] -> ShowS #

autoCloseToHeader :: AutoClose -> [Header] Source #

We return a list of headers so that we can treat the headers like a monoid.

data MMConn Source #

Constructors

MMConn
Fields fromMMConn :: Connection connConnected :: IORef Bool

Instances

Stream MMConn Source #	This instance allows us to use `simpleHTTP` from `Stream` with connections from the `connection` package.
Instance details Defined in Network.Mattermost.Types.Internal Methods readLine :: MMConn -> IO (Result String) # readBlock :: MMConn -> Int -> IO (Result String) # writeBlock :: MMConn -> String -> IO (Result ()) # close :: MMConn -> IO () # closeOnEnd :: MMConn -> Bool -> IO () #

closeMMConn :: MMConn -> IO () Source #

newMMConn :: Connection -> IO MMConn Source #

isConnected :: MMConn -> IO Bool Source #

maxLineLength :: Int Source #

dropTrailingChar :: ByteString -> ByteString Source #

HTTP ends newlines with rn sequence, but the connection package doesn't know this so we need to drop the r after reading lines. This should only be needed in your compatibility with the HTTP library.

data ConnectionType Source #

Constructors

ConnectHTTPS Bool	Boolean is whether to require trusted certificate
ConnectHTTP	Make an insecure connection over HTTP

Instances

Eq ConnectionType Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods (==) :: ConnectionType -> ConnectionType -> Bool # (/=) :: ConnectionType -> ConnectionType -> Bool #
Read ConnectionType Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods readsPrec :: Int -> ReadS ConnectionType # readList :: ReadS [ConnectionType] # readPrec :: ReadPrec ConnectionType # readListPrec :: ReadPrec [ConnectionType] #
Show ConnectionType Source #
Instance details Defined in Network.Mattermost.Types.Internal Methods showsPrec :: Int -> ConnectionType -> ShowS # show :: ConnectionType -> String # showList :: [ConnectionType] -> ShowS #

data ConnectionData Source #

Constructors

ConnectionData
Fields cdHostname :: Hostname cdPort :: Port cdUrlPath :: Text cdAutoClose :: AutoClose cdConnectionPool :: Pool MMConn cdConnectionCtx :: ConnectionContext cdToken :: Maybe Token cdLogger :: Maybe Logger cdConnectionType :: ConnectionType