Copyright	(c) Winterland 2016
License	BSD
Maintainer	drkoster@qq.com
Stability	experimental
Portability	PORTABLE
Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.MySQL.Protocol.Packet

Description

MySQL packet decoder&encoder, and varities utility.

Synopsis

data Packet = Packet {
- pLen :: !Int64
- pSeqN :: !Word8
- pBody :: !ByteString
}
putPacket :: Packet -> Put
getPacket :: Get Packet
isERR :: Packet -> Bool
isOK :: Packet -> Bool
isEOF :: Packet -> Bool
isThereMore :: OK -> Bool
decodeFromPacket :: Binary a => Packet -> IO a
getFromPacket :: Get a -> Packet -> IO a
data DecodePacketException = DecodePacketFailed ByteString ByteOffset String
encodeToPacket :: Binary a => Word8 -> a -> Packet
putToPacket :: Word8 -> Put -> Packet
data OK = OK {
- okAffectedRows :: !Int
- okLastInsertID :: !Int
- okStatus :: !Word16
- okWarningCnt :: !Word16
}
getOK :: Get OK
putOK :: OK -> Put
data ERR = ERR {
- errCode :: !Word16
- errState :: !ByteString
- errMsg :: !ByteString
}
getERR :: Get ERR
putERR :: ERR -> Put
data EOF = EOF {
- eofWarningCnt :: !Word16
- eofStatus :: !Word16
}
getEOF :: Get EOF
putEOF :: EOF -> Put
getByteStringNul :: Get ByteString
getRemainingByteString :: Get ByteString
putLenEncBytes :: ByteString -> Put
getLenEncBytes :: Get ByteString
getLenEncInt :: Get Int
putLenEncInt :: Int -> Put
putWord24le :: Word32 -> Put
getWord24le :: Get Word32
putWord48le :: Word64 -> Put
getWord48le :: Get Word64
getWord24be :: Get Word24
getInt24be :: Get Int24
getWord40be :: Get Word64
getWord48be :: Get Word64
getWord56be :: Get Word64

Documentation

data Packet Source #

MySQL packet type

Constructors

Packet
Fields pLen :: !Int64 pSeqN :: !Word8 pBody :: !ByteString

Instances

Instances details

Show Packet Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods showsPrec :: Int -> Packet -> ShowS # show :: Packet -> String # showList :: [Packet] -> ShowS #
Binary Packet Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods put :: Packet -> Put # get :: Get Packet # putList :: [Packet] -> Put #
Eq Packet Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods (==) :: Packet -> Packet -> Bool # (/=) :: Packet -> Packet -> Bool #

putPacket :: Packet -> Put Source #

getPacket :: Get Packet Source #

isERR :: Packet -> Bool Source #

isOK :: Packet -> Bool Source #

isEOF :: Packet -> Bool Source #

isThereMore :: OK -> Bool Source #

Is there more packet to be read?

https://dev.mysql.com/doc/internals/en/status-flags.html

decodeFromPacket :: Binary a => Packet -> IO a Source #

Decoding packet inside IO, throw DecodePacketException on fail parsing, here we choose stability over correctness by omit incomplete consumed case: if we successful parse a packet, then we don't care if there're bytes left.

getFromPacket :: Get a -> Packet -> IO a Source #

data DecodePacketException Source #

Constructors

DecodePacketFailed ByteString ByteOffset String

Instances

Instances details

Exception DecodePacketException Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods toException :: DecodePacketException -> SomeException # fromException :: SomeException -> Maybe DecodePacketException # displayException :: DecodePacketException -> String #
Show DecodePacketException Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods showsPrec :: Int -> DecodePacketException -> ShowS # show :: DecodePacketException -> String # showList :: [DecodePacketException] -> ShowS #

encodeToPacket :: Binary a => Word8 -> a -> Packet Source #

putToPacket :: Word8 -> Put -> Packet Source #

data OK Source #

You may get interested in OK packet because it provides information about successful operations.

Constructors

OK
Fields okAffectedRows :: !Int affected row number okLastInsertID :: !Int last insert's ID okStatus :: !Word16 okWarningCnt :: !Word16

Instances

Instances details

Show OK Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods showsPrec :: Int -> OK -> ShowS # show :: OK -> String # showList :: [OK] -> ShowS #
Binary OK Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods put :: OK -> Put # get :: Get OK # putList :: [OK] -> Put #
Eq OK Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods (==) :: OK -> OK -> Bool # (/=) :: OK -> OK -> Bool #

getOK :: Get OK Source #

putOK :: OK -> Put Source #

data ERR Source #

Constructors

ERR
Fields errCode :: !Word16 errState :: !ByteString errMsg :: !ByteString

Instances

Instances details

Show ERR Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods showsPrec :: Int -> ERR -> ShowS # show :: ERR -> String # showList :: [ERR] -> ShowS #
Binary ERR Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods put :: ERR -> Put # get :: Get ERR # putList :: [ERR] -> Put #
Eq ERR Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods (==) :: ERR -> ERR -> Bool # (/=) :: ERR -> ERR -> Bool #

getERR :: Get ERR Source #

putERR :: ERR -> Put Source #

data EOF Source #

Constructors

EOF
Fields eofWarningCnt :: !Word16 eofStatus :: !Word16

Instances

Instances details

Show EOF Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods showsPrec :: Int -> EOF -> ShowS # show :: EOF -> String # showList :: [EOF] -> ShowS #
Binary EOF Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods put :: EOF -> Put # get :: Get EOF # putList :: [EOF] -> Put #
Eq EOF Source #
Instance details Defined in Database.MySQL.Protocol.Packet Methods (==) :: EOF -> EOF -> Bool # (/=) :: EOF -> EOF -> Bool #

getEOF :: Get EOF Source #

putEOF :: EOF -> Put Source #

getByteStringNul :: Get ByteString Source #

getRemainingByteString :: Get ByteString Source #

putLenEncBytes :: ByteString -> Put Source #

getLenEncBytes :: Get ByteString Source #

getLenEncInt :: Get Int Source #

length encoded int https://dev.mysql.com/doc/internals/en/integer.html#packet-Protocol::LengthEncodedInteger

putLenEncInt :: Int -> Put Source #

putWord24le :: Word32 -> Put Source #

getWord24le :: Get Word32 Source #

putWord48le :: Word64 -> Put Source #

getWord48le :: Get Word64 Source #

getWord24be :: Get Word24 Source #

getInt24be :: Get Int24 Source #

getWord40be :: Get Word64 Source #

getWord48be :: Get Word64 Source #

getWord56be :: Get Word64 Source #