krustie 0.3.0

Krustie is a simple and easy-to-use backend framework.
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 std::fmt::{Display, Error, Formatter, Result as fResult};

#[derive(Eq, Hash, PartialEq, Debug)]
/// Represents an HTTP method
///
/// The HTTP method is used to indicate the desired action to be performed for a given resource.
///
/// # Supported methods
///
/// - GET
/// - POST
/// - PUT
/// - PATCH
/// - DELETE
///
#[derive(Clone)]
pub enum HttpMethod {
    /// GET method is used to request data from a specified resource
    GET,
    /// POST method is used to submit data to be processed to a specified resource
    POST,
    /// PUT method is used to update data to a specified resource
    PUT,
    /// PATCH method is used to apply partial modifications to a resource
    PATCH,
    /// DELETE method is used to delete a specified resource
    DELETE,
    // CONNTECT,
    // HEAD,
    // OPTIONS,
    // TRACE,
}

impl HttpMethod {
    pub(crate) fn is_valid(method: &str) -> bool {
        matches!(method, "GET" | "POST" | "PUT" | "PATCH" | "DELETE")
    }
}

impl Default for HttpMethod {
    fn default() -> Self {
        Self::GET
    }
}

impl Display for HttpMethod {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
        match self {
            Self::GET => write!(f, "GET"),
            Self::POST => write!(f, "POST"),
            Self::PUT => write!(f, "PUT"),
            Self::PATCH => write!(f, "PATCH"),
            Self::DELETE => write!(f, "DELETE"),
        }
    }
}

impl TryFrom<&str> for HttpMethod {
    type Error = ParseHttpMethodError;
    /// Converts a string to an HttpMethod
    ///
    /// # Errors
    ///
    /// Returns an error if the string is not a valid HTTP method
    ///
    /// # Example
    ///
    /// ```rust
    /// use krustie::HttpMethod;
    ///
    /// match HttpMethod::try_from("GET") {
    ///   Ok(method) => assert_eq!(method, HttpMethod::GET),
    ///   Err(_) => panic!("Failed to parse HTTP method"),
    /// }
    /// ```
    fn try_from(method: &str) -> Result<Self, Self::Error> {
        let method = method.to_uppercase();
        match method.as_str() {
            "GET" => Ok(Self::GET),
            "POST" => Ok(Self::POST),
            "PUT" => Ok(Self::PUT),
            "PATCH" => Ok(Self::PATCH),
            "DELETE" => Ok(Self::DELETE),
            _ => Err(ParseHttpMethodError),
        }
    }
}

/// Error for parsing an HTTP method
///
/// ```rust
/// use krustie::HttpMethod;
///
/// match HttpMethod::try_from("SET") {
///   Ok(_) => panic!("SET method should fail."),
///   Err(err) => assert_eq!(err.to_string(), "Invalid method for HTTP request"),
/// }
/// ```
#[derive(Debug)]
pub struct ParseHttpMethodError;

impl Display for ParseHttpMethodError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fResult {
        write!(f, "Invalid method for HTTP request")
    }
}