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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
use std::fmt::Debug;
use std::io;
use std::path::Path;
use std::sync::Arc;
use crate::endpoint::MiddlewareEndpoint;
use crate::fs::{ServeDir, ServeFile};
use crate::log;
use crate::{router::Router, Endpoint, Middleware};
/// A handle to a route.
///
/// All HTTP requests are made against resources. After using [`Server::at`] (or
/// [`Route::at`]) to establish a route, the `Route` type can be used to
/// establish endpoints for various HTTP methods at that path. Also, using
/// `nest`, it can be used to set up a subrouter.
///
/// [`Server::at`]: ./struct.Server.html#method.at
#[allow(missing_debug_implementations)]
pub struct Route<'a, State> {
router: &'a mut Router<State>,
path: String,
middleware: Vec<Arc<dyn Middleware<State>>>,
/// Indicates whether the path of current route is treated as a prefix. Set by
/// [`strip_prefix`].
///
/// [`strip_prefix`]: #method.strip_prefix
prefix: bool,
}
impl<'a, State: Clone + Send + Sync + 'static> Route<'a, State> {
pub(crate) fn new(router: &'a mut Router<State>, path: String) -> Route<'a, State> {
Route {
router,
path,
middleware: Vec::new(),
prefix: false,
}
}
/// Extend the route with the given `path`.
pub fn at<'b>(&'b mut self, path: &str) -> Route<'b, State> {
let mut p = self.path.clone();
if !p.ends_with('/') && !path.starts_with('/') {
p.push('/');
}
if path != "/" {
p.push_str(path);
}
Route {
router: &mut self.router,
path: p,
middleware: self.middleware.clone(),
prefix: false,
}
}
/// Get the current path.
#[must_use]
pub fn path(&self) -> &str {
&self.path
}
/// Treat the current path as a prefix, and strip prefixes from requests.
///
/// This method is marked unstable as its name might change in the near future.
///
/// Endpoints will be given a path with the prefix removed.
#[cfg(any(feature = "unstable", feature = "docs"))]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
pub fn strip_prefix(&mut self) -> &mut Self {
self.prefix = true;
self
}
/// Apply the given middleware to the current route.
pub fn with<M>(&mut self, middleware: M) -> &mut Self
where
M: Middleware<State>,
{
log::trace!(
"Adding middleware {} to route {:?}",
middleware.name(),
self.path
);
self.middleware.push(Arc::new(middleware));
self
}
/// Reset the middleware chain for the current route, if any.
pub fn reset_middleware(&mut self) -> &mut Self {
self.middleware.clear();
self
}
/// Nest a [`Server`] at the current path.
///
/// [`Server`]: struct.Server.html
pub fn nest<InnerState>(&mut self, service: crate::Server<InnerState>) -> &mut Self
where
State: Clone + Send + Sync + 'static,
InnerState: Clone + Send + Sync + 'static,
{
let prefix = self.prefix;
self.prefix = true;
self.all(service);
self.prefix = prefix;
self
}
/// Serve a directory statically.
///
/// Each file will be streamed from disk, and a mime type will be determined
/// based on magic bytes.
///
/// # Examples
///
/// Serve the contents of the local directory `./public/images/*` from
/// `localhost:8080/images/*`.
///
/// ```no_run
/// #[async_std::main]
/// async fn main() -> Result<(), std::io::Error> {
/// let mut app = tide::new();
/// app.at("/images").serve_dir("public/images/")?;
/// app.listen("127.0.0.1:8080").await?;
/// Ok(())
/// }
/// ```
pub fn serve_dir(&mut self, dir: impl AsRef<Path>) -> io::Result<()> {
// Verify path exists, return error if it doesn't.
let dir = dir.as_ref().to_owned().canonicalize()?;
let prefix = self.path().to_string();
self.at("*").get(ServeDir::new(prefix, dir));
Ok(())
}
/// Serve a static file.
///
/// The file will be streamed from disk, and a mime type will be determined
/// based on magic bytes. Similar to serve_dir
pub fn serve_file(&mut self, file: impl AsRef<Path>) -> io::Result<()> {
self.get(ServeFile::init(file)?);
Ok(())
}
/// Add an endpoint for the given HTTP method
pub fn method(&mut self, method: http_types::Method, ep: impl Endpoint<State>) -> &mut Self {
if self.prefix {
let ep = StripPrefixEndpoint::new(ep);
self.router.add(
&self.path,
method,
MiddlewareEndpoint::wrap_with_middleware(ep.clone(), &self.middleware),
);
let wildcard = self.at("*--tide-path-rest");
wildcard.router.add(
&wildcard.path,
method,
MiddlewareEndpoint::wrap_with_middleware(ep, &wildcard.middleware),
);
} else {
self.router.add(
&self.path,
method,
MiddlewareEndpoint::wrap_with_middleware(ep, &self.middleware),
);
}
self
}
/// Add an endpoint for all HTTP methods, as a fallback.
///
/// Routes with specific HTTP methods will be tried first.
pub fn all(&mut self, ep: impl Endpoint<State>) -> &mut Self {
if self.prefix {
let ep = StripPrefixEndpoint::new(ep);
self.router.add_all(
&self.path,
MiddlewareEndpoint::wrap_with_middleware(ep.clone(), &self.middleware),
);
let wildcard = self.at("*--tide-path-rest");
wildcard.router.add_all(
&wildcard.path,
MiddlewareEndpoint::wrap_with_middleware(ep, &wildcard.middleware),
);
} else {
self.router.add_all(
&self.path,
MiddlewareEndpoint::wrap_with_middleware(ep, &self.middleware),
);
}
self
}
/// Add an endpoint for `GET` requests
pub fn get(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Get, ep);
self
}
/// Add an endpoint for `HEAD` requests
pub fn head(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Head, ep);
self
}
/// Add an endpoint for `PUT` requests
pub fn put(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Put, ep);
self
}
/// Add an endpoint for `POST` requests
pub fn post(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Post, ep);
self
}
/// Add an endpoint for `DELETE` requests
pub fn delete(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Delete, ep);
self
}
/// Add an endpoint for `OPTIONS` requests
pub fn options(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Options, ep);
self
}
/// Add an endpoint for `CONNECT` requests
pub fn connect(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Connect, ep);
self
}
/// Add an endpoint for `PATCH` requests
pub fn patch(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Patch, ep);
self
}
/// Add an endpoint for `TRACE` requests
pub fn trace(&mut self, ep: impl Endpoint<State>) -> &mut Self {
self.method(http_types::Method::Trace, ep);
self
}
}
#[derive(Debug)]
struct StripPrefixEndpoint<E>(std::sync::Arc<E>);
impl<E> StripPrefixEndpoint<E> {
fn new(ep: E) -> Self {
Self(std::sync::Arc::new(ep))
}
}
impl<E> Clone for StripPrefixEndpoint<E> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
#[async_trait::async_trait]
impl<State, E> Endpoint<State> for StripPrefixEndpoint<E>
where
State: Clone + Send + Sync + 'static,
E: Endpoint<State>,
{
async fn call(&self, req: crate::Request<State>) -> crate::Result {
let crate::Request {
state,
mut req,
route_params,
} = req;
let rest = crate::request::rest(&route_params).unwrap_or("");
req.url_mut().set_path(&rest);
self.0
.call(crate::Request {
state,
req,
route_params,
})
.await
}
}