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
51

use super::Error;

/// Error when a schema definition is invalid.
///
/// This occurs when:
/// - A schema has duplicate names (index names, etc.)
/// - A column configuration is invalid (auto_increment on non-numeric type)
/// - Incompatible features are combined (auto_increment with composite keys)
/// - Required constraints are violated (auto_increment must be in primary key)
///
/// These errors are caught during schema construction/validation, typically at build time.
#[derive(Debug)]
pub(super) struct InvalidSchema {
    message: Box<str>,
}

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

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

impl Error {
    /// Creates an invalid schema error.
    ///
    /// This is used when a schema definition is invalid - duplicate names,
    /// invalid column configurations, incompatible features, etc.
    /// These errors are typically caught at build/migration time.
    ///
    /// # Examples
    ///
    /// ```
    /// use toasty_core::Error;
    ///
    /// let err = Error::invalid_schema("duplicate index name `idx_users`");
    /// assert!(err.is_invalid_schema());
    /// assert_eq!(err.to_string(), "invalid schema: duplicate index name `idx_users`");
    /// ```
    pub fn invalid_schema(message: impl Into<String>) -> Error {
        Error::from(super::ErrorKind::InvalidSchema(InvalidSchema {
            message: message.into().into(),
        }))
    }

    /// Returns `true` if this error is an invalid schema error.
    pub fn is_invalid_schema(&self) -> bool {
        matches!(self.kind(), super::ErrorKind::InvalidSchema(_))
    }
}