toasty_core/error/
serialization_failure.rs

1use super::Error;
2
3/// Error when a transaction is aborted due to a serialization conflict.
4///
5/// This maps to database-specific errors such as PostgreSQL SQLSTATE 40001
6/// or MySQL error 1213. The transaction must be retried.
7#[derive(Debug)]
8pub(super) struct SerializationFailure {
9    message: Box<str>,
10}
11
12impl std::error::Error for SerializationFailure {}
13
14impl core::fmt::Display for SerializationFailure {
15    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
16        write!(f, "transaction serialization failure: {}", self.message)
17    }
18}
19
20impl Error {
21    /// Creates a serialization failure error.
22    ///
23    /// Returned when the database aborts a transaction due to a serialization
24    /// conflict (e.g. PostgreSQL SQLSTATE 40001, MySQL error 1213).
25    ///
26    /// # Examples
27    ///
28    /// ```
29    /// use toasty_core::Error;
30    ///
31    /// let err = Error::serialization_failure("concurrent update conflict");
32    /// assert!(err.is_serialization_failure());
33    /// ```
34    pub fn serialization_failure(message: impl Into<String>) -> Error {
35        Error::from(super::ErrorKind::SerializationFailure(
36            SerializationFailure {
37                message: message.into().into(),
38            },
39        ))
40    }
41
42    /// Returns `true` if this error is a serialization failure.
43    pub fn is_serialization_failure(&self) -> bool {
44        matches!(self.kind(), super::ErrorKind::SerializationFailure(_))
45    }
46}