toasty-core 0.3.0

Core types, schema representations, and driver interface for Toasty
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

use super::Error;

/// Error when a database does not support a requested feature.
///
/// This occurs when:
/// - A statement type is not supported by the database (unsupported primitive type)
/// - A storage type is not available (VARCHAR not supported)
/// - A feature constraint is exceeded (VARCHAR size exceeds database limit)
///
/// These errors are typically caught during schema construction or validation,
/// indicating a mismatch between application requirements and database capabilities.
#[derive(Debug)]
pub(super) struct UnsupportedFeature {
    message: Box<str>,
}

impl std::error::Error for UnsupportedFeature {}

impl core::fmt::Display for UnsupportedFeature {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        write!(f, "unsupported feature: {}", self.message)
    }
}

impl Error {
    /// Creates an unsupported feature error.
    ///
    /// This is used when a database does not support a requested feature,
    /// such as a specific type, storage constraint, or capability.
    ///
    /// # Examples
    ///
    /// ```
    /// use toasty_core::Error;
    ///
    /// let err = Error::unsupported_feature("ARRAY type not supported");
    /// assert!(err.is_unsupported_feature());
    /// assert_eq!(err.to_string(), "unsupported feature: ARRAY type not supported");
    /// ```
    pub fn unsupported_feature(message: impl Into<String>) -> Error {
        Error::from(super::ErrorKind::UnsupportedFeature(UnsupportedFeature {
            message: message.into().into(),
        }))
    }

    /// Returns `true` if this error is an unsupported feature error.
    pub fn is_unsupported_feature(&self) -> bool {
        matches!(self.kind(), super::ErrorKind::UnsupportedFeature(_))
    }
}