risingwave_error/
common.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//! Commonly used error types.
16
17use std::fmt::{Display, Formatter};
18
19use thiserror::Error;
20use thiserror_ext::Macro;
21
22#[derive(Debug, Clone, Copy, Default)]
23pub struct TrackingIssue(Option<u32>);
24
25impl TrackingIssue {
26    pub fn new(id: u32) -> Self {
27        TrackingIssue(Some(id))
28    }
29
30    pub fn none() -> Self {
31        TrackingIssue(None)
32    }
33}
34
35impl From<u32> for TrackingIssue {
36    fn from(id: u32) -> Self {
37        TrackingIssue(Some(id))
38    }
39}
40
41impl From<Option<u32>> for TrackingIssue {
42    fn from(id: Option<u32>) -> Self {
43        TrackingIssue(id)
44    }
45}
46
47impl Display for TrackingIssue {
48    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
49        match self.0 {
50            Some(id) => write!(
51                f,
52                "Tracking issue: https://github.com/risingwavelabs/risingwave/issues/{id}"
53            ),
54            None => write!(
55                f,
56                "No tracking issue yet. Feel free to submit a feature request at https://github.com/risingwavelabs/risingwave/issues/new?labels=type%2Ffeature&template=feature_request.yml"
57            ),
58        }
59    }
60}
61
62#[derive(Error, Debug, Macro)]
63#[error("Feature is not yet implemented: {feature}\n{issue}")]
64#[thiserror_ext(macro(path = "crate::common"))]
65pub struct NotImplemented {
66    #[message]
67    pub feature: String,
68    pub issue: TrackingIssue,
69}
70
71#[derive(Error, Debug, Macro)]
72#[thiserror_ext(macro(path = "crate::common"))]
73pub struct NoFunction {
74    #[message]
75    pub sig: String,
76    pub candidates: Option<String>,
77}
78
79impl Display for NoFunction {
80    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
81        write!(f, "function {} does not exist", self.sig)?;
82        if let Some(candidates) = &self.candidates {
83            write!(f, ", do you mean {}", candidates)?;
84        }
85        Ok(())
86    }
87}
risingwave_error/common.rs

risingwave_error/
common.rs
