oxidy 0.5.0

Fast & Minimum Web Framework for Rust
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use crate::structs::request::Request;
use crate::structs::response::Response;
use crate::utils::del_vec::del_vec;
use crate::utils::get_vec::get_vec;
use crate::utils::set_vec::set_vec;

#[derive(Clone, Debug)]
pub struct Context {
    /// Next Function
    ///
    /// # Example
    ///
    /// ```
    /// use std::time::Instant;
    /// use oxidy::{Server, Context, Returns, middleware};
    ///
    /// async fn mid(mut c: Context) -> Returns {
    ///     let start: Instant = Instant::now();
    ///     c.response.body = "Middleware Function".to_owned();
    ///     c.next = true;
    ///     (c, None)
    /// }
    ///
    /// let mut app = Server::new();
    /// app.add(middleware!(mid));
    /// ```
    pub next: bool,
    pub(crate) state: Vec<(String, String)>,
    pub request: Request,
    pub response: Response,
}

impl Context {
    /// Get State
    ///
    /// State of Key Value pair to transfer data between Middlewares or Routes
    ///
    /// # Example
    ///
    /// ```
    /// use oxidy::{Server, Context, Returns, route, middleware};
    ///
    /// async fn mid(mut c: Context) -> Returns {
    ///     c.set_state("user", "John Doe").await;
    ///     (c, None)
    /// }
    ///
    /// async fn route(mut c: Context) -> Returns {
    ///     let user: Option<String> = c.get_state("user").await;
    ///     match user {
    ///         Some(u) => c.response.body = format!("Username: {}", u),
    ///         None => {
    ///             c.response.body = format!("Username not found");
    ///             c.response.status = 404;
    ///         },
    ///     }
    ///     (c, None)
    /// }
    ///
    /// let mut app = Server::new();
    /// app.add(middleware!(mid));
    /// app.add(route!("get /", route));
    /// ```
    pub async fn get_state(&self, key: &str) -> Option<String> {
        get_vec(&self.state, key.to_owned()).await
    }
    /// Set State
    ///
    /// State of Key Value pair to transfer data between Middlewares or Routes
    ///
    /// # Example
    ///
    /// ```
    /// use oxidy::{Server, Context, Returns, route, middleware};
    ///
    /// async fn mid(mut c: Context) -> Returns {
    ///     c.set_state("user", "John Doe").await;
    ///     (c, None)
    /// }
    ///
    /// async fn route(mut c: Context) -> Returns {
    ///     let user: Option<String> = c.get_state("user").await;
    ///     match user {
    ///         Some(u) => c.response.body = format!("Username: {}", u),
    ///         None => {
    ///             c.response.body = format!("Username not found");
    ///             c.response.status = 404;
    ///         },
    ///     }
    ///     (c, None)
    /// }
    ///
    /// let mut app = Server::new();
    /// app.add(middleware!(mid));
    /// app.add(route!("get /", route));
    /// ```
    pub async fn set_state(&mut self, key: &str, value: &str) {
        self.state = set_vec(&self.state, key.to_owned(), value.to_owned()).await;
    }
    /// Delete State
    ///
    /// State of Key Value pair to transfer data between Middlewares or Routes
    ///
    /// # Example
    ///
    /// ```
    /// use oxidy::{Server, Context, Returns, route, middleware};
    ///
    /// async fn mid(mut c: Context) -> Returns {
    ///     c.del_state("user").await;
    ///     (c, None)
    /// }
    ///
    /// async fn route(mut c: Context) -> Returns {
    ///     let user: Option<String> = c.get_state("user").await;
    ///     match user {
    ///         Some(u) => c.response.body = format!("Username: {}", u),
    ///         None => {
    ///             c.response.body = format!("Username not found");
    ///             c.response.status = 404;
    ///         },
    ///     }
    ///     (c, None)
    /// }
    ///
    /// let mut app = Server::new();
    /// app.add(middleware!(mid));
    /// app.add(route!("get /", route));
    /// ```
    pub async fn del_state(&mut self, key: &str) {
        self.state = del_vec(&self.state, key.to_owned()).await;
    }
}