hashira 0.0.2-alpha

A server side rendering framework build on top of Yew
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

mod on_before_render;
mod on_chunk_render;
mod on_client_error;
mod on_client_init;
mod on_handle;
mod on_server_error;
mod on_server_init;

pub use {
    on_before_render::*, on_chunk_render::*, on_client_error::*, on_client_init::*, on_handle::*,
    on_server_error::*, on_server_init::*,
};

use std::fmt::Display;

/// Represents a collection of event hooks.
#[derive(Default)]
pub struct Hooks {
    pub(crate) on_handle_hooks: Vec<Box<dyn OnHandle + Send + Sync>>,
    pub(crate) on_before_render_hooks: Vec<BoxOnBeforeRender>,
    pub(crate) on_chunk_render_hooks: Vec<Box<dyn OnChunkRender + Send + Sync>>,
    pub(crate) on_server_initialize_hooks: Vec<Box<dyn OnServerInitialize + Send + Sync>>,
    pub(crate) on_client_initialize_hooks: Vec<Box<dyn OnClientInitialize + Send + Sync>>,
    pub(crate) on_server_error_hooks: Vec<Box<dyn OnServerError + Send + Sync>>,
    pub(crate) on_client_error_hooks: Vec<Box<dyn OnClientError + Send + Sync>>,
}

impl Hooks {
    /// Constructs an empty collection of hooks.
    pub fn new() -> Self {
        Default::default()
    }

    /// Adds a hook to be executed before handling a request.
    #[allow(unused_mut, unused_variables)]
    pub fn on_handle<F>(mut self, f: F) -> Self
    where
        F: OnHandle + Clone + Send + Sync + 'static,
    {
        #[cfg(not(feature = "client"))]
        {
            self.on_handle_hooks.push(Box::new(f));
        }
        self
    }

    /// Adds a hook to be executed before rendering a response.
    #[allow(unused_mut, unused_variables)]
    pub fn on_before_render<F>(mut self, f: F) -> Self
    where
        F: OnBeforeRender + Send + Sync + 'static,
    {
        #[cfg(not(feature = "client"))]
        {
            self.on_before_render_hooks.push(BoxOnBeforeRender::new(f));
        }
        self
    }

    /// Adds a hook to be executed after rendering a chunk of a response.
    #[allow(unused_mut, unused_variables)]
    pub fn on_chunk_render<F>(mut self, f: F) -> Self
    where
        F: OnChunkRender + Send + Sync + 'static,
    {
        #[cfg(not(feature = "client"))]
        {
            self.on_chunk_render_hooks.push(Box::new(f));
        }
        self
    }

    /// Adds a hook to be executed when the server is initialized.
    #[allow(unused_mut, unused_variables)]
    pub fn on_server_initialize<F>(mut self, f: F) -> Self
    where
        F: OnServerInitialize + Send + Sync + 'static,
    {
        #[cfg(not(feature = "client"))]
        {
            self.on_server_initialize_hooks.push(Box::new(f));
        }

        self
    }

    /// Adds a hook to be executed when the client is initialized,
    /// this is ran after hydration.
    #[allow(unused_mut, unused_variables)]
    pub fn on_client_initialize<F>(mut self, f: F) -> Self
    where
        F: OnClientInitialize + Send + Sync + 'static,
    {
        #[cfg(feature = "client")]
        {
            self.on_client_initialize_hooks.push(Box::new(f));
        }

        self
    }

    /// Adds a hook to be executed when a server error occurs.
    #[allow(unused_mut, unused_variables)]
    pub fn on_server_error<F>(mut self, f: F) -> Self
    where
        F: OnServerError + Send + Sync + 'static,
    {
        #[cfg(not(feature = "client"))]
        {
            self.on_server_error_hooks.push(Box::new(f));
        }
        self
    }

    /// Adds a hook to be executed when a client error occurs.
    #[allow(unused_mut, unused_variables)]
    pub fn on_client_error<F>(mut self, f: F) -> Self
    where
        F: OnClientError + Send + Sync + 'static,
    {
        #[cfg(feature = "client")]
        {
            self.on_client_error_hooks.push(Box::new(f));
        }
        self
    }

    pub fn extend(&mut self, hooks: Hooks) {
        self.on_handle_hooks.extend(hooks.on_handle_hooks);

        self.on_before_render_hooks
            .extend(hooks.on_before_render_hooks);

        self.on_chunk_render_hooks
            .extend(hooks.on_chunk_render_hooks);

        self.on_server_initialize_hooks
            .extend(hooks.on_server_initialize_hooks);

        self.on_client_initialize_hooks
            .extend(hooks.on_client_initialize_hooks);

        self.on_server_error_hooks
            .extend(hooks.on_server_error_hooks);

        self.on_client_error_hooks
            .extend(hooks.on_client_error_hooks);
    }
}

impl Display for Hooks {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "Hooks")
    }
}