galvyn 0.3.0

Core-component for the galvyn web-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

//! [`GalvynRouter`] extension trait

use std::any::Any;

use galvyn_core::GalvynRouter;

use crate::openapi::metadata::OpenapiMetadata;

/// Extension trait for [`GalvynRouter`]
///
/// It provides convenient methods for adding openapi related metadata
/// to a route. (For example tags)
pub trait OpenapiRouterExt {
    /// Adds a tag to all handlers in this router
    fn openapi_tag(self, tag: &'static str) -> Self;

    /// Creates a new router with a tag
    ///
    /// (Shorthand for `GalvynRouter::new().openapi_tag(...)`)
    fn with_openapi_tag(tag: &'static str) -> Self;

    /// Associates a page with all handlers in this router
    ///
    /// ```
    /// # use galvyn::openapi::OpenapiRouterExt;
    /// # use galvyn_core::GalvynRouter;
    /// struct FrontendApi;
    /// struct MonitoringApi;
    ///
    /// GalvynRouter::new()
    ///     .nest(
    ///         "/api/frontend",
    ///         GalvynRouter::new()
    ///             .openapi_page(FrontendApi),
    ///     )
    ///     .nest(
    ///         "/api/monitoring",
    ///         GalvynRouter::new()
    ///             .openapi_page(MonitoringApi),
    ///     );
    /// ```
    fn openapi_page(self, page: impl Any) -> Self;

    /// Creates a new router with a page
    ///
    /// (Shorthand for `GalvynRouter::new().openapi_page(...)`)
    ///
    /// ```
    /// # use galvyn::openapi::OpenapiRouterExt;
    /// # use galvyn_core::GalvynRouter;
    /// struct FrontendApi;
    /// struct MonitoringApi;
    ///
    /// GalvynRouter::new()
    ///     .nest(
    ///         "/api/frontend",
    ///         GalvynRouter::with_openapi_page(FrontendApi),
    ///     )
    ///     .nest(
    ///         "/api/monitoring",
    ///         GalvynRouter::with_openapi_page(MonitoringApi),
    ///     );
    /// ```
    fn with_openapi_page(page: impl Any) -> Self;
}

impl OpenapiRouterExt for GalvynRouter {
    fn openapi_tag(self, tag: &'static str) -> Self {
        self.metadata(OpenapiMetadata {
            tags: vec![tag],
            pages: Vec::new(),
        })
    }

    fn with_openapi_tag(tag: &'static str) -> Self {
        Self::new().openapi_tag(tag)
    }

    fn openapi_page(self, page: impl Any) -> Self {
        assert_eq!(
            size_of_val(&page),
            0,
            "pages should be zero-sized marker types"
        );

        self.metadata(OpenapiMetadata {
            tags: Vec::new(),
            pages: vec![page.type_id()],
        })
    }

    fn with_openapi_page(page: impl Any) -> Self {
        Self::new().openapi_page(page)
    }
}