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

Database.MySQL.Protocol.Packet

Description

MySQL packet decoder&encoder, and varities utility.

Synopsis

Documentation

data Packet Source

MySQL packet type

Constructors

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

Instances

Eq Packet Source
Show Packet Source
Binary Packet Source

putPacket :: Packet -> Put Source

getPacket :: Get Packet Source

isERR :: Packet -> Bool Source

isOK :: Packet -> Bool Source

isEOF :: Packet -> Bool Source

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
DecodePacketPartial

Instances

Show DecodePacketException Source
Exception DecodePacketException Source

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

Eq OK Source
Show OK Source
Binary OK Source

getOK :: Get OK Source

putOK :: OK -> Put Source

data ERR Source

Constructors

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

Instances

Eq ERR Source
Show ERR Source
Binary ERR Source

getERR :: Get ERR Source

putERR :: ERR -> Put Source

data EOF Source

Constructors

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

Instances

Eq EOF Source
Show EOF Source
Binary EOF Source

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