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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
use std::{
convert::TryInto,
fmt::{self, Debug, Formatter},
net::IpAddr,
};
use trillium_http::{
transport::{BoxedTransport, Transport},
Body, HeaderName, HeaderValues, Headers, Method, ReceivedBody, StateSet, Status,
};
/**
# A Trillium HTTP connection.
A Conn represents both the request and response of a http connection,
as well as any application state that is associated with that
connection.
## `with_{attribute}` naming convention
A convention that is used throughout trillium is that any interface
that is named `with_{attribute}` will take ownership of the conn, set
the attribute and return the conn, enabling chained calls like:
```
struct MyState(&'static str);
async fn handler(mut conn: trillium::Conn) -> trillium::Conn {
conn.with_header("content-type", "text/plain")
.with_state(MyState("hello"))
.with_body("hey there")
.with_status(418)
}
use trillium_testing::prelude::*;
assert_response!(
get("/").on(&handler),
Status::ImATeapot,
"hey there",
"content-type" => "text/plain"
);
```
If you need to set a property on the conn without moving it,
`set_{attribute}` associated functions will be your huckleberry, as is
conventional in other rust projects.
## State
Every trillium Conn contains a state type which is a set that contains
at most one element for each type. State is the primary way that
handlers attach data to a conn as it passes through a tuple
handler. State access should generally be implemented by libraries
using a private type and exposed with a `ConnExt` trait. See [library
patterns](https://trillium.rs/library_patterns.html#state) for more
elaboration and examples.
## In relation to [`trillium_http::Conn`]
`trillium::Conn` is currently implemented as an abstraction on top of a
[`trillium_http::Conn`]. In particular, `trillium::Conn` boxes the
transport using a [`BoxedTransport`](trillium_http::transport::BoxedTransport)
so that application code can be written without transport
generics. See [`Transport`](trillium_http::transport::Transport) for further
reading on this.
*/
pub struct Conn {
inner: trillium_http::Conn<BoxedTransport>,
halted: bool,
path: Vec<String>,
}
impl Debug for Conn {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_struct("Conn")
.field("inner", &self.inner)
.field("halted", &self.halted)
.field("path", &self.path)
.finish()
}
}
impl<T: Transport + 'static> From<trillium_http::Conn<T>> for Conn {
fn from(inner: trillium_http::Conn<T>) -> Self {
Self {
inner: inner.map_transport(BoxedTransport::new),
halted: false,
path: vec![],
}
}
}
impl Conn {
/**
`Conn::ok` is a convenience function for the common pattern of
setting a body and a 200 status in one call. It is exactly
identical to `conn.with_status(200).with_body(body).halt()`
```
use trillium::Conn;
use trillium_testing::prelude::*;
let mut conn = get("/").on(&|conn: Conn| async move { conn.ok("hello") });
assert_body!(&mut conn, "hello");
assert_status!(&conn, 200);
assert!(conn.is_halted());
```
*/
#[must_use]
pub fn ok(self, body: impl Into<Body>) -> Self {
self.with_status(200).with_body(body).halt()
}
/**
returns the response status for this `Conn`, if it has been set.
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&());
assert!(conn.status().is_none());
conn.set_status(200);
assert_eq!(conn.status().unwrap(), Status::Ok);
```
*/
pub fn status(&self) -> Option<Status> {
self.inner.status()
}
/// assigns a status to this response. see [`Conn::status`] for example usage
pub fn set_status(&mut self, status: impl TryInto<Status>) {
self.inner.set_status(status);
}
/**
sets the response status for this `Conn` and returns it. note that
this does not set the halted status.
```
use trillium_testing::prelude::*;
let conn = get("/").on(&|conn: Conn| async move {
conn.with_status(418)
});
let status = conn.status().unwrap();
assert_eq!(status, Status::ImATeapot);
assert_eq!(status, 418);
assert!(!conn.is_halted());
```
*/
#[must_use]
pub fn with_status(mut self, status: impl TryInto<Status>) -> Self {
self.set_status(status);
self
}
/**
Sets the response body from any `impl Into<Body>` and returns the
`Conn` for fluent chaining. Note that this does not set the response
status or halted. See [`Conn::ok`] for a function that does both
of those.
```
use trillium_testing::prelude::*;
let conn = get("/").on(&|conn: Conn| async move {
conn.with_body("hello")
});
assert_eq!(conn.response_len(), Some(5));
```
*/
#[must_use]
pub fn with_body(mut self, body: impl Into<Body>) -> Self {
self.set_body(body);
self
}
/**
Sets the response body from any `impl Into<Body>`. Note that this does not set the response
status or halted.
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&());
conn.set_body("hello");
assert_eq!(conn.response_len(), Some(5));
```
*/
pub fn set_body(&mut self, body: impl Into<Body>) {
self.inner.set_response_body(body);
}
/**
Removes the response body from the `Conn`
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&());
conn.set_body("hello");
let mut body = conn.take_response_body().unwrap();
assert_eq!(body.len(), Some(5));
assert_eq!(conn.response_len(), None);
```
*/
pub fn take_response_body(&mut self) -> Option<Body> {
self.inner.take_response_body()
}
/**
Borrows the response body from the `Conn`
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&());
conn.set_body("hello");
let body = conn.response_body().unwrap();
assert_eq!(body.len(), Some(5));
assert!(body.is_static());
assert_eq!(body.static_bytes(), Some(&b"hello"[..]));
```
*/
pub fn response_body(&self) -> Option<&Body> {
self.inner.response_body()
}
/**
Attempts to retrieve a &T from the state set
```
use trillium_testing::prelude::*;
struct Hello;
let mut conn = get("/").on(&());
assert!(conn.state::<Hello>().is_none());
conn.set_state(Hello);
assert!(conn.state::<Hello>().is_some());
```
*/
pub fn state<T: 'static>(&self) -> Option<&T> {
self.inner.state().get()
}
/// Attempts to retrieve a &mut T from the state set
pub fn state_mut<T: 'static>(&mut self) -> Option<&mut T> {
self.inner.state_mut().get_mut()
}
/// Puts a new type into the state set. see [`Conn::state`]
/// for an example. returns the previous instance of this type, if
/// any
pub fn set_state<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T> {
self.inner.state_mut().insert(val)
}
/// Puts a new type into the state set and returns the
/// `Conn`. this is useful for fluent chaining
#[must_use]
pub fn with_state<T: Send + Sync + 'static>(mut self, val: T) -> Self {
self.set_state(val);
self
}
/// Removes a type from the state set and returns it, if present
pub fn take_state<T: Send + Sync + 'static>(&mut self) -> Option<T> {
self.inner.state_mut().take()
}
/**
Either returns the current &mut T from the state set, or
inserts a new one with the provided default function and
returns a mutable reference to it
*/
pub fn mut_state_or_insert_with<T, F>(&mut self, default: F) -> &mut T
where
T: Send + Sync + 'static,
F: FnOnce() -> T,
{
self.inner.state_mut().get_or_insert_with(default)
}
/**
Returns a [`ReceivedBody`] that references this `Conn`. The `Conn`
retains all data and holds the singular transport, but the
[`ReceivedBody`] provides an interface to read body content.
See also: [`Conn::request_body_string`] for a convenience function
when the content is expected to be utf8.
# Examples
```
use trillium_testing::prelude::*;
let mut conn = get("/").with_request_body("request body").on(&());
# trillium_testing::block_on(async {
let request_body = conn.request_body().await;
assert_eq!(request_body.content_length(), Some(12));
assert_eq!(request_body.read_string().await.unwrap(), "request body");
# });
```
*/
pub async fn request_body(&mut self) -> ReceivedBody<'_, BoxedTransport> {
self.inner.request_body().await
}
/**
Convenience function to read the content of a request body as a `String`.
# Errors
This will return an error variant if either there is an IO failure
on the underlying transport or if the body content is not a utf8
string.
# Examples
```
use trillium_testing::prelude::*;
let mut conn = get("/").with_request_body("request body").on(&());
# trillium_testing::block_on(async {
assert_eq!(conn.request_body_string().await.unwrap(), "request body");
# });
```
*/
#[allow(clippy::missing_errors_doc)] // this is a false positive
pub async fn request_body_string(&mut self) -> trillium_http::Result<String> {
self.request_body().await.read_string().await
}
/**
if there is a response body for this conn and it has a known
fixed length, it is returned from this function
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&|conn: trillium::Conn| async move {
conn.with_body("hello")
});
assert_eq!(conn.response_len(), Some(5));
```
*/
pub fn response_len(&self) -> Option<u64> {
self.inner.response_body().and_then(Body::len)
}
/**
returns the request method for this conn.
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&());
assert_eq!(conn.method(), Method::Get);
```
*/
pub fn method(&self) -> Method {
self.inner.method()
}
/// borrows the request headers
///
/// this is aliased as [`Conn::request_headers`]
pub fn headers(&self) -> &Headers {
self.inner.request_headers()
}
/// mutably borrows response headers
///
/// this is aliased as [`Conn::response_headers_mut`]
pub fn headers_mut(&mut self) -> &mut Headers {
self.inner.response_headers_mut()
}
/// borrow the response headers
pub fn response_headers(&self) -> &Headers {
self.inner.response_headers()
}
/// mutably borrow the response headers
///
/// this is aliased as [`Conn::headers_mut`]
pub fn response_headers_mut(&mut self) -> &mut Headers {
self.inner.response_headers_mut()
}
/// borrow the request headers
pub fn request_headers(&self) -> &Headers {
self.inner.request_headers()
}
/// mutably borrow request headers
pub fn request_headers_mut(&mut self) -> &mut Headers {
self.inner.request_headers_mut()
}
/**
insert a header name and value/values into the response headers
and return the conn. for a slight performance improvement, use a
[`KnownHeaderName`](crate::KnownHeaderName) as the first argument instead of a
str.
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&|conn: trillium::Conn| async move {
conn.with_header("content-type", "application/html")
});
```
*/
#[must_use]
pub fn with_header(
mut self,
header_name: impl Into<HeaderName<'static>>,
header_value: impl Into<HeaderValues>,
) -> Self {
self.headers_mut().insert(header_name, header_value);
self
}
/**
returns the path for this request. note that this may not
represent the entire http request path if running nested
routers.
*/
pub fn path(&self) -> &str {
self.path.last().map_or_else(|| self.inner.path(), |p| &**p)
}
/**
returns query part of the request path
```
use trillium_testing::prelude::*;
let conn = get("/a/b?c&d=e").on(&());
assert_eq!(conn.querystring(), "c&d=e");
let conn = get("/a/b").on(&());
assert_eq!(conn.querystring(), "");
```
# Parsing
Trillium does not include a querystring parsing library, as there is no universal standard for
querystring encodings of arrays, but several library options exist, inluding:
* [`QueryStrong`](https://docs.rs/querystrong/) (by the author of trillium)
* [`serde_qs`](https://docs.rs/serde_qs/)
* [`querystring`](https://docs.rs/querystring/)
* [`serde_querystring`](https://docs.rs/serde-querystring/latest/serde_querystring/)
*/
pub fn querystring(&self) -> &str {
self.inner.querystring()
}
/**
sets the `halted` attribute of this conn, preventing later
processing in a given tuple handler. returns
the conn for fluent chaining
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&|conn: trillium::Conn| async move {
conn.halt()
});
assert!(conn.is_halted());
```
*/
#[must_use]
pub fn halt(mut self) -> Self {
self.set_halted(true);
self
}
/**
sets the `halted` attribute of this conn. see [`Conn::halt`].
```
use trillium_testing::prelude::*;
let mut conn = get("/").on(&());
assert!(!conn.is_halted());
conn.set_halted(true);
assert!(conn.is_halted());
```
*/
pub fn set_halted(&mut self, halted: bool) {
self.halted = halted;
}
/// retrieves the halted state of this conn. see [`Conn::halt`].
pub const fn is_halted(&self) -> bool {
self.halted
}
/// predicate function to indicate whether the connection is
/// secure. note that this does not necessarily indicate that the
/// transport itself is secure, as it may indicate that
/// `trillium_http` is behind a trusted reverse proxy that has
/// terminated tls and provided appropriate headers to indicate
/// this.
pub fn is_secure(&self) -> bool {
self.inner.is_secure()
}
/// The [`Instant`] that the first header bytes for this conn were
/// received, before any processing or parsing has been performed.
pub fn start_time(&self) -> std::time::Instant {
self.inner.start_time()
}
/// returns an immutable reference to the inner
/// [`trillium_http::Conn`]. please open an issue if you need to do
/// this in application code.
///
/// stability note: hopefully this can go away at some point, but
/// for now is an escape hatch in case `trillium_http::Conn`
/// presents interfaces that cannot be reached otherwise.
pub const fn inner(&self) -> &trillium_http::Conn<BoxedTransport> {
&self.inner
}
/// returns a mutable reference to the inner
/// [`trillium_http::Conn`]. please open an issue if you need to
/// do this in application code.
///
/// stability note: hopefully this can go away at some point, but
/// for now is an escape hatch in case `trillium_http::Conn`
/// presents interfaces that cannot be reached otherwise.
pub fn inner_mut(&mut self) -> &mut trillium_http::Conn<BoxedTransport> {
&mut self.inner
}
/// transforms this `trillium::Conn` into a `trillium_http::Conn`
/// with the specified transport type. Please note that this will
/// panic if you attempt to downcast from trillium's boxed
/// transport into the wrong transport type. Also note that this
/// is a lossy conversion, dropping the halted state and any
/// nested router path data.
///
/// # Panics
///
/// This will panic if you attempt to downcast to the wrong Transport type.
pub fn into_inner<T: Transport>(self) -> trillium_http::Conn<T> {
self.inner.map_transport(|t| {
*t.downcast()
.expect("attempted to downcast to the wrong transport type")
})
}
/// retrieves the remote ip address for this conn, if available.
pub fn peer_ip(&self) -> Option<IpAddr> {
self.inner().peer_ip()
}
/// sets the remote ip address for this conn.
pub fn set_peer_ip(&mut self, peer_ip: Option<IpAddr>) {
self.inner_mut().set_peer_ip(peer_ip);
}
/// for router implementations. pushes a route segment onto the path
pub fn push_path(&mut self, path: String) {
self.path.push(path);
}
/// for router implementations. removes a route segment onto the path
pub fn pop_path(&mut self) {
self.path.pop();
}
}
impl AsMut<StateSet> for Conn {
fn as_mut(&mut self) -> &mut StateSet {
self.inner.state_mut()
}
}
impl AsRef<StateSet> for Conn {
fn as_ref(&self) -> &StateSet {
self.inner.state()
}
}