volga 0.8.9

Easy & Fast 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

use hyper::{Request, body::Incoming};
use std::sync::Arc;

use crate::{
    HttpResult,
    error::{
        FallbackFunc,
        fallback::{PipelineFallbackHandler, default_fallback_handler},
        handler::{DefaultErrorHandler, PipelineErrorHandler},
    },
    http::endpoints::Endpoints,
};

#[cfg(feature = "middleware")]
use crate::middleware::{HttpContext, Middlewares, NextFn};

pub(crate) struct PipelineBuilder {
    #[cfg(feature = "middleware")]
    middlewares: Middlewares,
    endpoints: Endpoints,
    error_handler: PipelineErrorHandler,
    fallback_handler: PipelineFallbackHandler,
}

impl std::fmt::Debug for PipelineBuilder {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("PipelineBuilder(..)")
    }
}

pub(crate) struct Pipeline {
    #[cfg(feature = "middleware")]
    start: Option<NextFn>,
    endpoints: Endpoints,
    error_handler: PipelineErrorHandler,
    fallback_handler: PipelineFallbackHandler,
}

impl PipelineBuilder {
    #[cfg(feature = "middleware")]
    pub(super) fn new() -> Self {
        Self {
            middlewares: Middlewares::new(),
            endpoints: Endpoints::new(),
            error_handler: Arc::new(DefaultErrorHandler),
            fallback_handler: FallbackFunc::new(default_fallback_handler).into(),
        }
    }

    #[cfg(not(feature = "middleware"))]
    pub(super) fn new() -> Self {
        Self {
            endpoints: Endpoints::new(),
            error_handler: Arc::new(DefaultErrorHandler),
            fallback_handler: FallbackFunc::new(default_fallback_handler).into(),
        }
    }

    #[cfg(feature = "middleware")]
    pub(super) fn build(mut self) -> Pipeline {
        let start = self.middlewares.compose();
        self.endpoints.compose();
        Pipeline {
            endpoints: self.endpoints,
            error_handler: self.error_handler,
            fallback_handler: self.fallback_handler,
            start,
        }
    }

    #[cfg(not(feature = "middleware"))]
    pub(super) fn build(self) -> Pipeline {
        Pipeline {
            endpoints: self.endpoints,
            error_handler: self.error_handler,
            fallback_handler: self.fallback_handler,
        }
    }

    #[cfg(feature = "middleware")]
    pub(crate) fn has_middleware_pipeline(&self) -> bool {
        !self.middlewares.is_empty()
    }

    #[cfg(feature = "middleware")]
    pub(crate) fn middlewares_mut(&mut self) -> &mut Middlewares {
        &mut self.middlewares
    }

    pub(crate) fn endpoints_mut(&mut self) -> &mut Endpoints {
        &mut self.endpoints
    }

    pub(crate) fn endpoints(&self) -> &Endpoints {
        &self.endpoints
    }

    pub(crate) fn set_error_handler(&mut self, handler: PipelineErrorHandler) {
        self.error_handler = handler;
    }

    pub(crate) fn set_fallback_handler(&mut self, handler: PipelineFallbackHandler) {
        self.fallback_handler = handler;
    }
}

impl Pipeline {
    #[inline]
    pub(crate) fn endpoints(&self) -> &Endpoints {
        &self.endpoints
    }

    #[inline]
    pub(super) fn error_handler(&self) -> &PipelineErrorHandler {
        &self.error_handler
    }

    #[inline]
    pub(super) async fn fallback(&self, req: Request<Incoming>) -> HttpResult {
        self.fallback_handler.call(req).await
    }

    #[cfg(feature = "middleware")]
    pub(crate) fn has_middleware_pipeline(&self) -> bool {
        self.start.is_some()
    }

    #[cfg(feature = "middleware")]
    pub(crate) async fn execute(&self, ctx: HttpContext) -> HttpResult {
        if let Some(next) = &self.start {
            next(ctx).await
        } else {
            ctx.execute().await
        }
    }
}

#[cfg(test)]
mod tests {
    use super::PipelineBuilder;
    use crate::error::{
        ErrorFunc, FallbackFunc, fallback::PipelineFallbackHandler, handler::PipelineErrorHandler,
    };
    use crate::status;

    #[test]
    fn it_sets_error_and_fallback_handlers() {
        let mut builder = PipelineBuilder::new();

        let error_handler: PipelineErrorHandler =
            ErrorFunc::new(|_err| async { status!(418) }).into();
        builder.set_error_handler(error_handler.clone());
        assert!(std::sync::Arc::ptr_eq(
            &builder.error_handler,
            &error_handler
        ));

        let fallback_handler: PipelineFallbackHandler =
            FallbackFunc::new(|| async { status!(404) }).into();
        builder.set_fallback_handler(fallback_handler.clone());
        assert!(std::sync::Arc::ptr_eq(
            &builder.fallback_handler,
            &fallback_handler
        ));
    }

    #[cfg(feature = "middleware")]
    #[test]
    fn it_builds_without_middleware_pipeline() {
        let builder = PipelineBuilder::new();
        assert!(!builder.has_middleware_pipeline());

        let pipeline = builder.build();
        assert!(!pipeline.has_middleware_pipeline());
    }
}