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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
#[cfg(engine)]
use super::super::fn_types::*;
use super::TemplateInner;
#[cfg(engine)]
use crate::errors::*;
use crate::{
reactor::Reactor,
state::{AnyFreeze, MakeRx, MakeUnrx, UnreactiveState},
};
#[cfg(engine)]
use http::HeaderMap;
use serde::{de::DeserializeOwned, Serialize};
use sycamore::prelude::BoundedScope;
use sycamore::prelude::{create_child_scope, create_ref};
#[cfg(engine)]
use sycamore::web::SsrNode;
use sycamore::{prelude::Scope, view::View, web::Html};
impl<G: Html> TemplateInner<G> {
// The view functions below are shadowed for widgets, and therefore these
// definitions only apply to templates, not capsules!
/// Sets the template rendering function to use, if the template takes
/// state. Templates that do not take state should use `.template()`
/// instead.
///
/// The closure wrapping this performs will automatically handle suspense
/// state.
// Generics are swapped here for nicer manual specification
pub fn view_with_state<I, F>(mut self, val: F) -> Self
where
// The state is made reactive on the child
F: for<'app, 'child> Fn(BoundedScope<'app, 'child>, &'child I) -> View<G>
+ Send
+ Sync
+ 'static,
I: MakeUnrx + AnyFreeze + Clone,
I::Unrx: MakeRx<Rx = I> + Serialize + DeserializeOwned + Send + Sync + Clone + 'static,
{
self.view = Box::new(
#[allow(unused_variables)]
move |app_cx, preload_info, template_state, path| {
let reactor = Reactor::<G>::from_cx(app_cx);
// This will handle frozen/active state prioritization, etc.
let intermediate_state =
reactor.get_page_state::<I::Unrx>(&path, template_state)?;
// Run the user's code in a child scope so any effects they start are killed
// when the page ends (otherwise we basically get a series of
// continuous pseudo-memory leaks, which can also cause accumulations of
// listeners on things like the router state)
let mut view = View::empty();
let disposer = ::sycamore::reactive::create_child_scope(app_cx, |child_cx| {
// Compute suspended states
#[cfg(any(client, doc))]
intermediate_state.compute_suspense(child_cx);
view = val(child_cx, create_ref(child_cx, intermediate_state));
});
Ok((view, disposer))
},
);
self
}
/// Sets the template rendering function to use, if the template takes
/// unreactive state.
pub fn view_with_unreactive_state<F, S>(mut self, val: F) -> Self
where
F: Fn(Scope, S) -> View<G> + Send + Sync + 'static,
S: MakeRx + Serialize + DeserializeOwned + UnreactiveState + 'static,
<S as MakeRx>::Rx: AnyFreeze + Clone + MakeUnrx<Unrx = S>,
{
self.view = Box::new(
#[allow(unused_variables)]
move |app_cx, preload_info, template_state, path| {
let reactor = Reactor::<G>::from_cx(app_cx);
// This will handle frozen/active state prioritization, etc.
let intermediate_state = reactor.get_page_state::<S>(&path, template_state)?;
let mut view = View::empty();
let disposer = create_child_scope(app_cx, |child_cx| {
// We go back from the unreactive state type wrapper to the base type (since
// it's unreactive)
view = val(child_cx, intermediate_state.make_unrx());
});
Ok((view, disposer))
},
);
self
}
/// Sets the template rendering function to use for templates that take no
/// state. Templates that do take state should use
/// `.template_with_state()` instead.
pub fn view<F>(mut self, val: F) -> Self
where
F: Fn(Scope) -> View<G> + Send + Sync + 'static,
{
self.view = Box::new(move |app_cx, _preload_info, _template_state, path| {
let reactor = Reactor::<G>::from_cx(app_cx);
// Declare that this page/widget will never take any state to enable full
// caching
reactor.register_no_state(&path, false);
// Nicely, if this is a widget, this means there need be no network requests
// at all!
let mut view = View::empty();
let disposer = ::sycamore::reactive::create_child_scope(app_cx, |child_cx| {
view = val(child_cx);
});
Ok((view, disposer))
});
self
}
/// Sets the document `<head>` rendering function to use. The [`View`]
/// produced by this will only be rendered on the engine-side, and will
/// *not* be reactive (since it only contains metadata).
///
/// This is for heads that do require state. Those that do not should use
/// `.head()` instead.
#[cfg(engine)]
pub fn head_with_state<S, V>(
mut self,
val: impl Fn(Scope, S) -> V + Send + Sync + 'static,
) -> Self
where
S: Serialize + DeserializeOwned + MakeRx + 'static,
V: Into<GeneratorResult<View<SsrNode>>>,
{
let template_name = self.get_path();
self.head = Some(Box::new(move |cx, template_state| {
// Make sure now that there is actually state
if template_state.is_empty() {
return Err(ClientError::InvariantError(ClientInvariantError::NoState).into());
}
// Declare a type on the untyped state (this doesn't perform any conversions,
// but the type we declare may be invalid)
let typed_state = template_state.change_type::<S>();
let state =
match typed_state.into_concrete() {
Ok(state) => state,
Err(err) => {
return Err(ClientError::InvariantError(
ClientInvariantError::InvalidState { source: err },
)
.into())
}
};
let template_name = template_name.clone();
val(cx, state)
.into()
.into_server_result("head", template_name)
}));
self
}
/// Sets the document `<head>` rendering function to use. The [`View`]
/// produced by this will only be rendered on the engine-side, and will
/// *not* be reactive (since it only contains metadata).
///
/// This is for heads that do require state. Those that do not should use
/// `.head()` instead.
#[cfg(any(client, doc))]
pub fn head_with_state(self, _val: impl Fn() + 'static) -> Self {
self
}
/// Sets the function to set headers. This will override Perseus' inbuilt
/// header defaults. This should only be used when your header-setting
/// requires knowing the state.
#[cfg(engine)]
pub fn set_headers_with_state<S, V>(
mut self,
val: impl Fn(Scope, S) -> V + Send + Sync + 'static,
) -> Self
where
S: Serialize + DeserializeOwned + MakeRx + 'static,
V: Into<GeneratorResult<HeaderMap>>,
{
let template_name = self.get_path();
self.set_headers = Some(Box::new(move |cx, template_state| {
// Make sure now that there is actually state
if template_state.is_empty() {
return Err(ClientError::InvariantError(ClientInvariantError::NoState).into());
}
// Declare a type on the untyped state (this doesn't perform any conversions,
// but the type we declare may be invalid)
let typed_state = template_state.change_type::<S>();
let state =
match typed_state.into_concrete() {
Ok(state) => state,
Err(err) => {
return Err(ClientError::InvariantError(
ClientInvariantError::InvalidState { source: err },
)
.into())
}
};
let template_name = template_name.clone();
val(cx, state)
.into()
.into_server_result("set_headers", template_name)
}));
self
}
/// Sets the function to set headers. This will override Perseus' inbuilt
/// header defaults. This should only be used when your header-setting
/// requires knowing the state.
#[cfg(any(client, doc))]
pub fn set_headers_with_state(self, _val: impl Fn() + 'static) -> Self {
self
}
}