vdf_serde_format/

error.rs

use std;
use std::fmt::{self, Display};

use serde::{de, ser};

pub type Result<T> = std::result::Result<T, Error>;

// This is a bare-bones implementation. A real library would provide additional
// information in its error type, for example the line and column at which the
// error occurred, the byte offset into the input, or the current key being
// processed.
#[derive(Debug, PartialEq)]
pub enum Error {
    // One or more variants that can be created by data structures through the
    // `ser::Error` and `de::Error` traits. For example the Serialize impl for
    // Mutex<T> might return an error because the mutex is poisoned, or the
    // Deserialize impl for a struct may return an error because a required
    // field is missing.
    Message(String),

    // Zero or more variants that can be created directly by the Serializer and
    // Deserializer without going through `ser::Error` and `de::Error`. These
    // are specific to the format, in this case JSON.
    Eof,
    Syntax,
    ExpectedBoolean,
    ExpectedInteger,
    ExpectedString,
    ExpectedNull,
    ExpectedArray,
    ExpectedMap,
    ExpectedMapKey,
    ExpectedMapEnd,
    ExpectedEnum,
    CannotSupportedTupleType,
    TrailingCharacters,

    ExpectedStringOrBlock,
    UnsupportedEnums,
    UnsupportedSelfDiscribing,
}

impl ser::Error for Error {
    fn custom<T: Display>(msg: T) -> Self {
        Error::Message(msg.to_string())
    }
}

impl de::Error for Error {
    fn custom<T: Display>(msg: T) -> Self {
        Error::Message(msg.to_string())
    }
}

impl Display for Error {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Error::Message(msg) => formatter.write_str(msg),
            Error::Eof => formatter.write_str("unexpected end of input"),
            Error::Syntax => formatter.write_str("syntax error"),
            Error::ExpectedBoolean => formatter.write_str("expected boolean"),
            Error::ExpectedInteger => formatter.write_str("expected integer"),
            Error::ExpectedString => formatter.write_str("expected string"),
            Error::ExpectedNull => formatter.write_str("expected null"),
            Error::ExpectedArray => formatter.write_str("expected array"),
            Error::ExpectedMap => formatter.write_str("expected map"),
            Error::ExpectedMapKey => formatter.write_str("expected map key"),
            Error::ExpectedMapEnd => formatter.write_str("expected map end"),
            Error::ExpectedEnum => formatter.write_str("expected enum"),
            Error::CannotSupportedTupleType => formatter.write_str("cannot supported tuple type, make a Tuple Struct instead, i.e. enum { Example { x: i32, y: i32 } } or "),
            Error::TrailingCharacters => formatter.write_str("trailing characters"),
            Error::ExpectedStringOrBlock => formatter.write_str("expected string or block"),
            Error::UnsupportedEnums => formatter.write_str("unsupported enums"),
            Error::UnsupportedSelfDiscribing => formatter.write_str("unsupported self-discribing [ANY]"),
            /* and so forth */
            // #[allow(unreachable_patterns)]
            // _ => formatter.write_str("unknown parse error"),
        }
    }
}

impl std::error::Error for Error {}
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_display_message() {
        let error = Error::Message("custom error".to_string());
        assert_eq!(format!("{}", error), "custom error");
    }

    #[test]
    fn test_display_eof() {
        let error = Error::Eof;
        assert_eq!(format!("{}", error), "unexpected end of input");
    }

    #[test]
    fn test_display_syntax() {
        let error = Error::Syntax;
        assert_eq!(format!("{}", error), "syntax error");
    }

    #[test]
    fn test_display_expected_boolean() {
        let error = Error::ExpectedBoolean;
        assert_eq!(format!("{}", error), "expected boolean");
    }

    #[test]
    fn test_display_expected_integer() {
        let error = Error::ExpectedInteger;
        assert_eq!(format!("{}", error), "expected integer");
    }

    #[test]
    fn test_display_expected_string() {
        let error = Error::ExpectedString;
        assert_eq!(format!("{}", error), "expected string");
    }

    #[test]
    fn test_display_expected_null() {
        let error = Error::ExpectedNull;
        assert_eq!(format!("{}", error), "expected null");
    }

    #[test]
    fn test_display_expected_array() {
        let error = Error::ExpectedArray;
        assert_eq!(format!("{}", error), "expected array");
    }

    #[test]
    fn test_display_expected_map() {
        let error = Error::ExpectedMap;
        assert_eq!(format!("{}", error), "expected map");
    }

    #[test]
    fn test_display_expected_map_key() {
        let error = Error::ExpectedMapKey;
        assert_eq!(format!("{}", error), "expected map key");
    }

    #[test]
    fn test_display_expected_map_end() {
        let error = Error::ExpectedMapEnd;
        assert_eq!(format!("{}", error), "expected map end");
    }

    #[test]
    fn test_display_expected_enum() {
        let error = Error::ExpectedEnum;
        assert_eq!(format!("{}", error), "expected enum");
    }

    #[test]
    fn test_display_cannot_supported_tuple_type() {
        let error = Error::CannotSupportedTupleType;
        assert_eq!(format!("{}", error), "cannot supported tuple type, make a Tuple Struct instead, i.e. enum { Example { x: i32, y: i32 } } or ");
    }

    #[test]
    fn test_display_trailing_characters() {
        let error = Error::TrailingCharacters;
        assert_eq!(format!("{}", error), "trailing characters");
    }

    #[test]
    fn test_display_expected_string_or_block() {
        let error = Error::ExpectedStringOrBlock;
        assert_eq!(format!("{}", error), "expected string or block");
    }

    #[test]
    fn test_display_unsupported_enums() {
        let error = Error::UnsupportedEnums;
        assert_eq!(format!("{}", error), "unsupported enums");
    }

    #[test]
    fn test_display_unsupported_self_discribing() {
        let error = Error::UnsupportedSelfDiscribing;
        assert_eq!(format!("{}", error), "unsupported self-discribing [ANY]");
    }

    #[test]
    fn test_display_unknown() {
        let error = Error::Message("unknown error".to_string());
        assert_eq!(format!("{}", error), "unknown error");
    }

    #[test]
    fn test_ser_error() {
        let error: Error = ser::Error::custom("serialization error");
        assert_eq!(error, Error::Message("serialization error".to_string()));
    }

    #[test]
    fn test_de_error() {
        let error: Error = de::Error::custom("deserialization error");
        assert_eq!(error, Error::Message("deserialization error".to_string()));
    }
}