serde_db 0.12.0

Deserialization of database result sets, and serialization of database parameters
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use thiserror::Error;

/// Error that can occur while serializing a standard rust type or struct into a SQL parameter.
#[derive(Error)] //Copy, Clone, Debug, Eq, PartialEq,
pub enum SerializationError {
    /// Error occured within the serde framework
    #[error("Error occured within the serde framework")]
    Serde(String),

    /// Error occured while parsing the SQL parameter from the given String representation
    #[error("Error occured while parsing the SQL parameter from the given String representation")]
    Parse {
        /// value
        value: String,
        /// Target SQL type
        db_type: String,

        /// The causing Error
        cause: Option<Box<dyn std::error::Error + Send + Sync + 'static>>,
    },

    /// The structure of the provided type does not fit to the required list of parameters
    #[error("The structure of the provided type does not fit to the required list of parameters")]
    StructuralMismatch(&'static str),

    /// The input type does not fit to the required database type
    #[error("The input type does not fit to the required database type")]
    Type {
        /// Type of the value that is being serialized
        value_type: &'static str,
        /// Type of the target db parameter
        db_type: String,
    },

    /// The input value is too big or too small for the required database type
    #[error("The input value is too big or too small for the required database type")]
    Range(&'static str, String),
}

/// Factory for Parse Error.
pub fn parse_error<S: AsRef<str>>(
    value: S,
    db_type: String,
    cause: Option<Box<dyn std::error::Error + Send + Sync + 'static>>,
) -> SerializationError {
    SerializationError::Parse {
        value: value.as_ref().to_string(),
        db_type,
        cause,
    }
}

/// Factory for Type Error.
#[must_use]
pub fn type_error(value: &'static str, db_type: String) -> SerializationError {
    SerializationError::Type {
        value_type: value,
        db_type,
    }
}

impl From<&'static str> for SerializationError {
    fn from(error: &'static str) -> SerializationError {
        SerializationError::StructuralMismatch(error)
    }
}

impl serde::ser::Error for SerializationError {
    fn custom<T: std::fmt::Display>(msg: T) -> Self {
        SerializationError::Serde(msg.to_string())
    }
}

impl std::fmt::Debug for SerializationError {
    fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
        match *self {
            SerializationError::Serde(ref s) => write!(fmt, "{self}: {s}"),
            SerializationError::StructuralMismatch(s) => write!(fmt, "{self}: {s}"),
            SerializationError::Parse {
                ref value,
                ref db_type,
                ref cause,
            } => match cause {
                Some(e) => write!(
                    fmt,
                    "given String \"{value}\" cannot be parsed into SQL type {db_type} due to {e}",
                ),
                None => write!(
                    fmt,
                    "given String \"{value}\" cannot be parsed into SQL type {db_type}",
                ),
            },
            SerializationError::Type {
                value_type,
                ref db_type,
            } => write!(
                fmt,
                "given value of type \"{value_type}\" cannot be converted into value of type code {db_type}",
            ),
            SerializationError::Range(s1, ref s2) => write!(
                fmt,
                "given value of type \"{s1}\" does not fit into supported range of SQL type {s2}",
            ),
        }
    }
}