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
//! Defines types for passing request state through `Middleware` and `Handler` implementations
pub(crate) mod client_addr;
mod data;
mod from_state;
pub mod request_id;
use log::{debug, trace};
use http::request;
use hyper::upgrade::OnUpgrade;
use hyper::{Body, Request};
use std::any::{Any, TypeId};
use std::collections::HashMap;
use std::net::SocketAddr;
pub use crate::state::client_addr::client_addr;
pub use crate::state::data::StateData;
pub use crate::state::from_state::FromState;
pub use crate::state::request_id::request_id;
use crate::helpers::http::request::path::RequestPathSegments;
use crate::state::client_addr::put_client_addr;
pub(crate) use crate::state::request_id::set_request_id;
/// Provides storage for request state, and stores one item of each type. The types used for
/// storage must implement the `gotham::state::StateData` trait to allow its storage. The
/// `gotham_derive` crate provides a custom derive for `StateData` to make this more convenient.
///
/// # Examples
///
/// ```rust
/// extern crate gotham;
/// #[macro_use]
/// extern crate gotham_derive;
///
/// use gotham::state::State;
///
/// #[derive(StateData)]
/// struct MyStruct {
/// value: i32
/// }
///
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 1 });
/// assert_eq!(state.borrow::<MyStruct>().value, 1);
/// #
/// # });
/// # }
/// ```
pub struct State {
data: HashMap<TypeId, Box<dyn Any + Send>>,
}
impl State {
/// Creates a new, empty `State` container. This is for internal Gotham use, because the
/// ability to create a new `State` container would allow for libraries and applications to
/// incorrectly discard important internal data.
pub(crate) fn new() -> State {
State {
data: HashMap::new(),
}
}
/// Creates a new, empty `State` and yields it mutably into the provided closure. This is
/// intended only for use in the documentation tests for `State`, since the `State` container
/// cannot be constructed otherwise.
#[doc(hidden)]
pub fn with_new<F>(f: F)
where
F: FnOnce(&mut State),
{
f(&mut State::new())
}
/// Instantiate a new `State` for a given `Request`. This is primarily useful if you're calling
/// Gotham from your own Hyper service.
pub fn from_request(req: Request<Body>, client_addr: SocketAddr) -> Self {
let mut state = Self::new();
put_client_addr(&mut state, client_addr);
let (
request::Parts {
method,
uri,
version,
headers,
mut extensions,
..
},
body,
) = req.into_parts();
state.put(RequestPathSegments::new(uri.path()));
state.put(method);
state.put(uri);
state.put(version);
state.put(headers);
state.put(body);
if let Some(on_upgrade) = extensions.remove::<OnUpgrade>() {
state.put(on_upgrade);
}
{
let request_id = set_request_id(&mut state);
debug!(
"[DEBUG][{}][Thread][{:?}]",
request_id,
std::thread::current().id(),
);
};
state
}
/// Puts a value into the `State` storage. One value of each type is retained. Successive calls
/// to `put` will overwrite the existing value of the same type.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # #[derive(StateData)]
/// # struct AnotherStruct {
/// # value: &'static str
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 1 });
/// assert_eq!(state.borrow::<MyStruct>().value, 1);
///
/// state.put(AnotherStruct { value: "a string" });
/// state.put(MyStruct { value: 100 });
///
/// assert_eq!(state.borrow::<AnotherStruct>().value, "a string");
/// assert_eq!(state.borrow::<MyStruct>().value, 100);
/// #
/// # });
/// # }
/// ```
pub fn put<T>(&mut self, t: T)
where
T: StateData,
{
let type_id = TypeId::of::<T>();
trace!(" inserting record to state for type_id `{:?}`", type_id);
self.data.insert(type_id, Box::new(t));
}
/// Determines if the current value exists in `State` storage.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # #[derive(StateData)]
/// # struct AnotherStruct {
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 1 });
/// assert!(state.has::<MyStruct>());
/// assert_eq!(state.borrow::<MyStruct>().value, 1);
///
/// assert!(!state.has::<AnotherStruct>());
/// #
/// # });
/// # }
/// ```
pub fn has<T>(&self) -> bool
where
T: StateData,
{
let type_id = TypeId::of::<T>();
self.data.get(&type_id).is_some()
}
/// Tries to borrow a value from the `State` storage.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # #[derive(StateData)]
/// # struct AnotherStruct {
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 1 });
/// assert!(state.try_borrow::<MyStruct>().is_some());
/// assert_eq!(state.try_borrow::<MyStruct>().unwrap().value, 1);
///
/// assert!(state.try_borrow::<AnotherStruct>().is_none());
/// #
/// # });
/// # }
/// ```
pub fn try_borrow<T>(&self) -> Option<&T>
where
T: StateData,
{
let type_id = TypeId::of::<T>();
trace!(" borrowing state data for type_id `{:?}`", type_id);
self.data.get(&type_id).and_then(|b| b.downcast_ref::<T>())
}
/// Borrows a value from the `State` storage.
///
/// # Panics
///
/// If a value of type `T` is not present in `State`.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 1 });
/// assert_eq!(state.borrow::<MyStruct>().value, 1);
/// #
/// # });
/// # }
/// ```
pub fn borrow<T>(&self) -> &T
where
T: StateData,
{
self.try_borrow()
.expect("required type is not present in State container")
}
/// Tries to mutably borrow a value from the `State` storage.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # #[derive(StateData)]
/// # struct AnotherStruct {
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 100 });
///
/// if let Some(a) = state.try_borrow_mut::<MyStruct>() {
/// a.value += 10;
/// }
///
/// assert_eq!(state.borrow::<MyStruct>().value, 110);
///
/// assert!(state.try_borrow_mut::<AnotherStruct>().is_none());
/// # });
/// # }
pub fn try_borrow_mut<T>(&mut self) -> Option<&mut T>
where
T: StateData,
{
let type_id = TypeId::of::<T>();
trace!(" mutably borrowing state data for type_id `{:?}`", type_id);
self.data
.get_mut(&type_id)
.and_then(|b| b.downcast_mut::<T>())
}
/// Mutably borrows a value from the `State` storage.
///
/// # Panics
///
/// If a value of type `T` is not present in `State`.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # #[derive(StateData)]
/// # struct AnotherStruct {
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 100 });
///
/// {
/// let a = state.borrow_mut::<MyStruct>();
/// a.value += 10;
/// }
///
/// assert_eq!(state.borrow::<MyStruct>().value, 110);
///
/// assert!(state.try_borrow_mut::<AnotherStruct>().is_none());
/// #
/// # });
/// # }
pub fn borrow_mut<T>(&mut self) -> &mut T
where
T: StateData,
{
self.try_borrow_mut()
.expect("required type is not present in State container")
}
/// Tries to move a value out of the `State` storage and return ownership.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # #[derive(StateData)]
/// # struct AnotherStruct {
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 110 });
///
/// assert_eq!(state.try_take::<MyStruct>().unwrap().value, 110);
///
/// assert!(state.try_take::<MyStruct>().is_none());
/// assert!(state.try_borrow_mut::<MyStruct>().is_none());
/// assert!(state.try_borrow::<MyStruct>().is_none());
///
/// assert!(state.try_take::<AnotherStruct>().is_none());
/// #
/// # });
/// # }
pub fn try_take<T>(&mut self) -> Option<T>
where
T: StateData,
{
let type_id = TypeId::of::<T>();
trace!(
" taking ownership from state data for type_id `{:?}`",
type_id
);
self.data
.remove(&type_id)
.and_then(|b| b.downcast::<T>().ok())
.map(|b| *b)
}
/// Moves a value out of the `State` storage and returns ownership.
///
/// # Panics
///
/// If a value of type `T` is not present in `State`.
///
/// # Examples
///
/// ```rust
/// # extern crate gotham;
/// # #[macro_use]
/// # extern crate gotham_derive;
/// #
/// # use gotham::state::State;
/// #
/// # #[derive(StateData)]
/// # struct MyStruct {
/// # value: i32
/// # }
/// #
/// # fn main() {
/// # State::with_new(|state| {
/// #
/// state.put(MyStruct { value: 110 });
///
/// assert_eq!(state.take::<MyStruct>().value, 110);
///
/// assert!(state.try_take::<MyStruct>().is_none());
/// assert!(state.try_borrow_mut::<MyStruct>().is_none());
/// assert!(state.try_borrow::<MyStruct>().is_none());
/// #
/// # });
/// # }
pub fn take<T>(&mut self) -> T
where
T: StateData,
{
self.try_take()
.expect("required type is not present in State container")
}
}