lambda-router 0.1.5

//! # error
//! a series of different errors that can occur
//! most handle de/serialization errors

use lambda_http::ext::PayloadError;
use serde::Serialize;
use serde_with::{serde_as, DisplayFromStr};
use thiserror::Error;

#[serde_as]
#[derive(Debug, Error, Serialize)]
pub enum Error {
    /// an error occurred when trying to serialize from a json body payload
    #[error("{0}")]
    SerializeJSON(
        #[from]
        #[serde_as(as = "DisplayFromStr")]
        serde_json::Error,
    ),

    /// an error occurred when trying to deserialize from a url encoded query string
    #[error("{0}")]
    DeserializeURLEncoded(
        #[from]
        #[serde_as(as = "DisplayFromStr")]
        serde_urlencoded::de::Error,
    ),

    /// an error occurred when trying to deserialize from the request body
    #[error("{0}")]
    Payload(#[serde_as(as = "DisplayFromStr")] PayloadError),

    /// the route did not match what was expected
    /// this variant will never bubble, because it's "caught" by the default_router which
    /// if not provided will cause a compiler_error from the **router** macro
    #[error("not found")]
    NotFound,

    /// the method did not match what was expected
    #[error("method not allowed")]
    MethodNotAllowed,

    /// there was no payload sent bt all handlers are expected to get data, if you want to get no data, use the "unit" type of that data format, i.e in json this is null or use an empty struct
    #[error("no payload")]
    NoPayload,
}

impl Error {
    /// checks if not found 404
    pub fn is_not_found(&self) -> bool {
        matches!(self, Self::NotFound)
    }

    /// convert errors to status codes
    pub fn status_code(&self) -> u16 {
        match self {
            Self::NotFound => 404,
            Self::MethodNotAllowed => 405,
            _ => 400,
        }
    }

    /// wraps the error in a Result<(), Error> and serializes as json
    pub fn json(&self) -> Result<String, Self> {
        let err: Result<(), &Self> = Err(self);
        Ok(serde_json::to_string(&err)?)
    }
}