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

use alloc::string::{String, ToString};
use core::fmt::{Debug, Display, Formatter, Result};

macro_rules! impl_error {
    ($trait:ty) => {
        impl $trait for SerdeError {
            fn custom<T: Display>(msg: T) -> Self {
                let msg = msg.to_string();
                Self { msg, pos: 0 }
            }
        }
    };
}

/// The error type for the serialization.
///
/// If the error is used at deserializing to a custom data,
/// the field [`SerdeError.pos`] will provide the position of the original YAML document.
#[derive(Debug)]
pub struct SerdeError {
    /// Message.
    pub msg: String,
    /// The original position of the node if provided.
    ///
    /// If not provided, this field becomes zero.
    pub pos: u64,
}

impl SerdeError {
    pub(crate) fn pos(mut self, pos: u64) -> Self {
        self.pos = pos;
        self
    }
}

impl From<String> for SerdeError {
    fn from(msg: String) -> Self {
        Self { msg, pos: 0 }
    }
}

impl Display for SerdeError {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        Debug::fmt(self, f)
    }
}

#[cfg(feature = "serde-std")]
impl std::error::Error for SerdeError {}

impl_error!(serde::ser::Error);
impl_error!(serde::de::Error);