Module protos

Module protos 

Source
Expand description

MySQL Client/Server Protocol Implementation: https://dev.mysql.com/doc/internals/en/client-server-protocol.html

Modules§

format
Protocol Serialization Format Fragments

Structs§

AuthMoreData
More data sent from server while authentication flow: https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::AuthMoreData
AuthMoreDataResponse
AuthMoreData or ERR_Packet
BinaryResultsetRow
Single row in binary protocol representation: https://dev.mysql.com/doc/internals/en/binary-protocol-resultset-row.html
BinaryResultsetRowValues
An iterator decoding values from a binary protocol row
ByteString
ByteString style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
CapabilityFlags
Client/Server Capability Flags: https://dev.mysql.com/doc/internals/en/capability-flags.html#packet-Protocol::CapabilityFlags
ColumnDefinition41
Double
Double style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
EOFPacket41
EOF_Packet(4.1 Protocol): https://dev.mysql.com/doc/internals/en/packet-EOF_Packet.html
EOFPacket41Format
Format Fragment of EOFPacket41.
ErrPacket
ERR_Packet: https://dev.mysql.com/doc/internals/en/packet-ERR_Packet.html
Float
Float style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
GenericOKErrPacket
OK_Packet or ERR_Packet, with sequence id.
HandshakeResponse41
Handshake Response(new): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::HandshakeResponse41
HandshakeResponse320
Handshake Response(old): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::HandshakeResponse320
HandshakeV9
Handshake V9(old protocol): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
HandshakeV9Format
Format Fragment for HandshakeV9
HandshakeV10Long
Handshake V10(fullset): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
HandshakeV10Short
Handshake V10(least common payload): https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
HandshakeV10ShortFormat
Format Fragment for HandshakeV10Short
Int
Int style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
InvalidColumnTypeError
LengthEncodedInteger
Length-Encoded Integer Format implementation: https://dev.mysql.com/doc/internals/en/integer.html#length-encoded-integer
LongLong
LongLong style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
OKPacket
OK_Packet: https://dev.mysql.com/doc/internals/en/packet-OK_Packet.html
PacketHeader
The header of all MySQL packets: https://dev.mysql.com/doc/internals/en/mysql-packet.html
PublicKeyRequest
Request for “public key retrieval” in sha2 authentication: https://dev.mysql.com/doc/internals/en/public-key-retrieval.html
QueryCommand
QuitCommand
Tells to server to close the connection: https://dev.mysql.com/doc/internals/en/com-quit.html
RawColumnDefinition41
RawColumnDefinition41Format
RawEOFPacket41
RawEOFPacket41Format
RawHandshakeV9
RawHandshakeV9Format
RawHandshakeV10Short
RawHandshakeV10ShortProtocolFormat
RawStmtPrepareOk
RawStmtPrepareOkFormat
ResultsetRow
ResultsetValueDecomposer
SSLRequest
SSL Connection Request: https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::SSLRequest
Short
Short style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
StatusFlags
Server Status Flags: https://dev.mysql.com/doc/internals/en/status-flags.html#packet-Protocol::StatusFlags
StmtCloseCommand
Deallocates a prepared statement: https://dev.mysql.com/doc/internals/en/com-stmt-close.html
StmtExecuteCommand
Execute a prepared statement: https://dev.mysql.com/doc/internals/en/com-stmt-execute.html
StmtExecuteFlags
Execution Flags for Prepared Statement: https://dev.mysql.com/doc/internals/en/com-stmt-execute.html
StmtPrepareCommand
Creates a prepared statement: https://dev.mysql.com/doc/internals/en/com-stmt-prepare.html
StmtPrepareOk
OK Response for Prepared Statement: https://dev.mysql.com/doc/internals/en/com-stmt-prepare-response.html
StmtPrepareOkFormat
Format Fragment for StmtPrepareOk
StmtPrepareResult
Statement Prepare OK or Errored
StmtResetCommand
Resets prepared statement data: https://dev.mysql.com/doc/internals/en/com-stmt-reset.html
Tiny
Tiny style format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html

Enums§

BinaryResultset41
Resultset packet in binary protocol
ColumnType
A Column Type byte: https://dev.mysql.com/doc/internals/en/com-query-response.html#column-type
Handshake
Handshake Packet from Server: https://dev.mysql.com/doc/internals/en/connection-phase-packets.html
OKPacketCapabilityExtraData
Capability dependent data in OKPacket.
QueryCommandResponse
Resultset41
ResultsetValue
StmtExecuteResult
Result of Prepared Statement Execution: https://dev.mysql.com/doc/internals/en/com-stmt-execute-response.html
Value
A value in resultset/sql

Traits§

AsyncReceivePacket
A packet that knows how to receive it from server asynchronously.
BinaryProtocolValue
An value of binary protocol
ClientPacket
The client-side packet.
ClientPacketIO
Client Packet(Self) - Server Packet Communication Definition.
ReceivePacket
A packet that knows how to receive it from server synchronously.
ValueFormat
Binary Protocol Value format: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html

Functions§

drop_packet
Drops single packet(non-blocking op).
drop_packet_sync
Drops single packet(blocking op).
request
Blocking communication between client and server.
request_async
Non-blocking communication between client and server.
serialize_null_bitmap
Serialize a null bitmap into bytes
serialize_value_types
Serialize value types into bytes
serialize_values
Serialize values into bytes
write_packet
Writes a packet(non-blocking op).
write_packet_sync
Writes a packet(blocking op).

Type Aliases§

HandshakeResult
Final packet of Handshake flow