pgwire/
error_or_notice.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15/// ErrorOrNoticeMessage defines messages that can appear in ErrorResponse and NoticeResponse.
16pub struct ErrorOrNoticeMessage<'a> {
17    pub severity: Severity,
18    pub state: SqlState,
19    pub message: &'a str,
20}
21
22impl<'a> ErrorOrNoticeMessage<'a> {
23    pub fn internal_error(message: &'a str) -> Self {
24        Self {
25            severity: Severity::Error,
26            state: SqlState::INTERNAL_ERROR,
27            message,
28        }
29    }
30
31    pub fn notice(message: &'a str) -> Self {
32        Self {
33            severity: Severity::Notice,
34            state: SqlState::SUCCESSFUL_COMPLETION,
35            message,
36        }
37    }
38}
39
40/// Severity: the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING,
41/// NOTICE, DEBUG, INFO, or LOG (in a notice message), or a localized translation of one of these.
42/// Always present.
43#[derive(PartialEq, Eq, Clone, Debug)]
44pub enum Severity {
45    Error,
46    Fatal,
47    Panic,
48    Notice,
49    Warning,
50    Debug,
51    Log,
52    Info,
53}
54
55impl Severity {
56    pub fn as_str(&self) -> &str {
57        match self {
58            Severity::Error => "ERROR",
59            Severity::Fatal => "FATAL",
60            Severity::Panic => "PANIC",
61            Severity::Notice => "NOTICE",
62            Severity::Warning => "WARNING",
63            Severity::Debug => "DEBUG",
64            Severity::Log => "LOG",
65            Severity::Info => "INFO",
66        }
67    }
68}
69
70/// Code: the SQLSTATE code for the error (see <https://www.postgresql.org/docs/current/errcodes-appendix.html>).
71/// Not localizable. Always present.
72#[derive(PartialEq, Eq, Clone, Debug)]
73#[allow(clippy::upper_case_acronyms)]
74pub enum Code {
75    E00000,
76    E01000,
77    EXX000,
78}
79
80/// SQLSTATE error code.
81#[derive(PartialEq, Eq, Clone, Debug)]
82pub struct SqlState(Code);
83
84impl SqlState {
85    /// Class XX — Internal Error
86    pub const INTERNAL_ERROR: SqlState = SqlState(Code::EXX000);
87    /// Class 00 — Successful Completion
88    pub const SUCCESSFUL_COMPLETION: SqlState = SqlState(Code::E00000);
89    /// Class 01 — Warning
90    pub const WARNING: SqlState = SqlState(Code::E01000);
91
92    pub fn code(&self) -> &str {
93        match &self.0 {
94            Code::E00000 => "00000",
95            Code::E01000 => "01000",
96            Code::EXX000 => "XX000",
97        }
98    }
99}
pgwire/error_or_notice.rs

pgwire/
error_or_notice.rs
