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 statement is invalid.
///
/// This occurs when:
/// - A statement references a non-existent field
/// - A statement contains invalid operations for a given field type
/// - A statement has incorrect structure or arguments
///
/// These errors are caught during statement lowering/execution, at runtime.
/// This is distinct from schema validation errors which occur at build/migration time.
#[derive(Debug)]
pub(super) struct InvalidStatement {
    pub(super) message: Box<str>,
}

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

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

impl Error {
    /// Creates an invalid statement error.
    ///
    /// This is used when a statement is malformed or references invalid schema elements.
    /// These errors occur during statement lowering/execution at runtime.
    ///
    /// # Examples
    ///
    /// ```
    /// use toasty_core::Error;
    ///
    /// let err = Error::invalid_statement("field `foo` does not exist");
    /// assert!(err.is_invalid_statement());
    /// assert_eq!(err.to_string(), "invalid statement: field `foo` does not exist");
    /// ```
    pub fn invalid_statement(message: impl Into<String>) -> Error {
        Error::from(super::ErrorKind::InvalidStatement(InvalidStatement {
            message: message.into().into(),
        }))
    }

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