sqlx_mysql/protocol/response/
err.rs

1use bytes::{Buf, Bytes};
2
3use crate::error::Error;
4use crate::io::{BufExt, ProtocolDecode};
5use crate::protocol::Capabilities;
6
7// https://dev.mysql.com/doc/dev/mysql-server/8.0.12/page_protocol_basic_err_packet.html
8// https://mariadb.com/kb/en/err_packet/
9
10/// Indicates that an error occurred.
11#[derive(Debug)]
12pub struct ErrPacket {
13    pub error_code: u16,
14    pub sql_state: Option<String>,
15    pub error_message: String,
16}
17
18impl ProtocolDecode<'_, Capabilities> for ErrPacket {
19    fn decode_with(mut buf: Bytes, capabilities: Capabilities) -> Result<Self, Error> {
20        let header = buf.get_u8();
21        if header != 0xff {
22            return Err(err_protocol!(
23                "expected 0xff (ERR_Packet) but found 0x{:x}",
24                header
25            ));
26        }
27
28        let error_code = buf.get_u16_le();
29        let mut sql_state = None;
30
31        if capabilities.contains(Capabilities::PROTOCOL_41) {
32            // If the next byte is '#' then we have a SQL STATE
33            if buf.starts_with(b"#") {
34                buf.advance(1);
35                sql_state = Some(buf.get_str(5)?);
36            }
37        }
38
39        let error_message = buf.get_str(buf.len())?;
40
41        Ok(Self {
42            error_code,
43            sql_state,
44            error_message,
45        })
46    }
47}
48
49#[test]
50fn test_decode_err_packet_out_of_order() {
51    const ERR_PACKETS_OUT_OF_ORDER: &[u8] = b"\xff\x84\x04Got packets out of order";
52
53    let p =
54        ErrPacket::decode_with(ERR_PACKETS_OUT_OF_ORDER.into(), Capabilities::PROTOCOL_41).unwrap();
55
56    assert_eq!(&p.error_message, "Got packets out of order");
57    assert_eq!(p.error_code, 1156);
58    assert_eq!(p.sql_state, None);
59}
60
61#[test]
62fn test_decode_err_packet_unknown_database() {
63    const ERR_HANDSHAKE_UNKNOWN_DB: &[u8] = b"\xff\x19\x04#42000Unknown database \'unknown\'";
64
65    let p =
66        ErrPacket::decode_with(ERR_HANDSHAKE_UNKNOWN_DB.into(), Capabilities::PROTOCOL_41).unwrap();
67
68    assert_eq!(p.error_code, 1049);
69    assert_eq!(p.sql_state.as_deref(), Some("42000"));
70    assert_eq!(&p.error_message, "Unknown database \'unknown\'");
71}
sqlx_mysql/protocol/response/err.rs

sqlx_mysql/protocol/response/
err.rs
