zrx_module/module/error/
convert.rs

1// Copyright (c) 2025-2026 Zensical and contributors
2
3// SPDX-License-Identifier: MIT
4// Third-party contributions licensed under DCO
5
6// Permission is hereby granted, free of charge, to any person obtaining a copy
7// of this software and associated documentation files (the "Software"), to
8// deal in the Software without restriction, including without limitation the
9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23
24// ----------------------------------------------------------------------------
25
26//! Module error conversions.
27
28use std::error;
29
30use super::Error;
31
32// ----------------------------------------------------------------------------
33// Traits
34// ----------------------------------------------------------------------------
35
36/// Conversion into [`Error`].
37pub trait IntoError {
38    /// Converts into a module error.
39    ///
40    /// This method is intended to be used within [`Module::setup`][], to make
41    /// it convenient to convert an arbitrary error into a module error.
42    ///
43    /// [`Module::setup`]: crate::Module::setup
44    fn into_error(self) -> Error;
45}
46
47// ----------------------------------------------------------------------------
48// Blanket implementations
49// ----------------------------------------------------------------------------
50
51impl<E> IntoError for E
52where
53    E: error::Error + Send + 'static,
54{
55    /// Converts any error into a module error.
56    ///
57    /// This implementation attempts to downcast the error into one of the known
58    /// variants, and falls back to the [`Error::Other`] variant in other cases.
59    /// It also ensures that the error is not double-boxed, returning unknown
60    /// errors captured by the [`Error::Other`] variant unchanged.
61    #[inline]
62    fn into_error(self) -> Error {
63        let mut err: Box<dyn error::Error + Send> = Box::new(self);
64        err = match err.downcast() {
65            Ok(err) => return *err,
66            Err(err) => err,
67        };
68
69        // Implements downcast attempt of error
70        macro_rules! downcast {
71            ($variant:path) => {
72                err = match err.downcast() {
73                    Ok(err) => return $variant(*err),
74                    Err(err) => err,
75                }
76            };
77        }
78
79        // Downcast known error variants
80        downcast!(Error::Id);
81        downcast!(Error::Expression);
82
83        // Handle unknown error variants
84        Error::Other(err)
85    }
86}
zrx_module/module/error/convert.rs

zrx_module/module/error/
convert.rs
