Database.MySQL.Protocol.Packet

MySQL packet decoder&encoder, and varities utility.

Documentation

data Packet

MySQL packet type

Constructors

Packet

Fields

• pLen :: !Int64
• pSeqN :: !Word8
• pBody :: !ByteString

Instances

Show Packet

Defined in Database.MySQL.Protocol.Packet

Methods

showsPrec :: Int -> Packet -> ShowS

show :: Packet -> String

showList :: [Packet] -> ShowS

Binary Packet

Defined in Database.MySQL.Protocol.Packet

Methods

put :: Packet -> Put

get :: Get Packet

putList :: [Packet] -> Put

Eq Packet

Defined in Database.MySQL.Protocol.Packet

Methods

(==) :: Packet -> Packet -> Bool

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

putPacket :: Packet -> Put

getPacket :: Get Packet

isERR :: Packet -> Bool

isOK :: Packet -> Bool

isEOF :: Packet -> Bool

isThereMore :: OK -> Bool

Is there more packet to be read?

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

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

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

data DecodePacketException

Constructors

DecodePacketFailed ByteString ByteOffset String

Instances

Exception DecodePacketException

Defined in Database.MySQL.Protocol.Packet

Methods

toException :: DecodePacketException -> SomeException

fromException :: SomeException -> Maybe DecodePacketException

displayException :: DecodePacketException -> String

Show DecodePacketException

Defined in Database.MySQL.Protocol.Packet

Methods

showsPrec :: Int -> DecodePacketException -> ShowS

show :: DecodePacketException -> String

showList :: [DecodePacketException] -> ShowS

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

putToPacket :: Word8 -> Put -> Packet

data OK

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

Show OK

Defined in Database.MySQL.Protocol.Packet

Methods

showsPrec :: Int -> OK -> ShowS

show :: OK -> String

showList :: [OK] -> ShowS

Binary OK

Defined in Database.MySQL.Protocol.Packet

Methods

put :: OK -> Put

get :: Get OK

putList :: [OK] -> Put

Eq OK

Defined in Database.MySQL.Protocol.Packet

Methods

(==) :: OK -> OK -> Bool

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

getOK :: Get OK

putOK :: OK -> Put

data ERR

Constructors

ERR

Fields

• errCode :: !Word16
• errState :: !ByteString
• errMsg :: !ByteString

Instances

Show ERR

Defined in Database.MySQL.Protocol.Packet

Methods

showsPrec :: Int -> ERR -> ShowS

show :: ERR -> String

showList :: [ERR] -> ShowS

Binary ERR

Defined in Database.MySQL.Protocol.Packet

Methods

put :: ERR -> Put

get :: Get ERR

putList :: [ERR] -> Put

Eq ERR

Defined in Database.MySQL.Protocol.Packet

Methods

(==) :: ERR -> ERR -> Bool

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

getERR :: Get ERR

putERR :: ERR -> Put

data EOF

Constructors

EOF

Fields

• eofWarningCnt :: !Word16
• eofStatus :: !Word16

Instances

Show EOF

Defined in Database.MySQL.Protocol.Packet

Methods

showsPrec :: Int -> EOF -> ShowS

show :: EOF -> String

showList :: [EOF] -> ShowS

Binary EOF

Defined in Database.MySQL.Protocol.Packet

Methods

put :: EOF -> Put

get :: Get EOF

putList :: [EOF] -> Put

Eq EOF

Defined in Database.MySQL.Protocol.Packet

Methods

(==) :: EOF -> EOF -> Bool

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

getEOF :: Get EOF

putEOF :: EOF -> Put

getByteStringNul :: Get ByteString

getRemainingByteString :: Get ByteString

putLenEncBytes :: ByteString -> Put

getLenEncBytes :: Get ByteString

getLenEncInt :: Get Int

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

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