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
use http::{HeaderMap, Method, Uri, Version}; use http_service::Body; use route_recognizer::Params; use std::{str::FromStr, sync::Arc}; /// Data associated with a request-response lifecycle. /// /// The `Context` gives endpoints access to basic information about the incoming /// request, route parameters, and various ways of accessing the request's body. /// /// Contexts also provide *extensions*, a type map primarily used for low-level /// communication between middleware and endpoints. pub struct Context<AppData> { app_data: Arc<AppData>, request: http_service::Request, route_params: Params, } impl<AppData> Context<AppData> { pub(crate) fn new( app_data: Arc<AppData>, request: http::Request<Body>, route_params: Params, ) -> Context<AppData> { Context { app_data, request, route_params, } } /// Access the request's HTTP method. pub fn method(&self) -> &Method { self.request.method() } /// Access the request's full URI method. pub fn uri(&self) -> &Uri { self.request.uri() } /// Access the request's HTTP version. pub fn version(&self) -> Version { self.request.version() } /// Access the request's headers. pub fn headers(&self) -> &HeaderMap { self.request.headers() } /// Access the entire request. pub fn request(&self) -> &http_service::Request { &self.request } /// Access app-global data. pub fn app_data(&self) -> &AppData { &self.app_data } /// Extract and parse a route parameter by name. /// /// Returns the results of parsing the parameter according to the inferred /// output type `T`. /// /// The name should *not* include the leading `:` or the trailing `*` (if /// any). /// /// # Errors /// /// Yields an `Err` if the parameter was found but failed to parse as an /// instance of type `T`. /// /// # Panics /// /// Panic if `key` is not a parameter for the route. pub fn param<T: FromStr>(&self, key: &str) -> Result<T, T::Err> { self.route_params.find(key).unwrap().parse() } /// Reads the entire request body into a byte buffer. /// /// This method can be called after the body has already been read, but will /// produce an empty buffer. /// /// # Errors /// /// Any I/O error encountered while reading the body is immediately returned /// as an `Err`. pub async fn body_bytes(&mut self) -> std::io::Result<Vec<u8>> { await!(self.take_body().into_vec()) } /// Reads the entire request body into a string. /// /// This method can be called after the body has already been read, but will /// produce an empty buffer. /// /// # Errors /// /// Any I/O error encountered while reading the body is immediately returned /// as an `Err`. /// /// If the body cannot be interpreted as valid UTF-8, an `Err` is returned. pub async fn body_string(&mut self) -> std::io::Result<String> { let body_bytes = await!(self.body_bytes())?; Ok(String::from_utf8(body_bytes).map_err(|_| std::io::ErrorKind::InvalidData)?) } /// Reads and deserialized the entire request body via json. /// /// # Errors /// /// Any I/O error encountered while reading the body is immediately returned /// as an `Err`. /// /// If the body cannot be interpreted as valid json for the target type `T`, /// an `Err` is returned. pub async fn body_json<T: serde::de::DeserializeOwned>(&mut self) -> std::io::Result<T> { let body_bytes = await!(self.body_bytes())?; Ok(serde_json::from_slice(&body_bytes).map_err(|_| std::io::ErrorKind::InvalidData)?) } /// Remove ownership of the request body, replacing it with an empty body. /// /// Used primarily for working directly with the body stream. pub fn take_body(&mut self) -> Body { std::mem::replace(self.request.body_mut(), Body::empty()) } /// Access the extensions to the context. pub fn extensions(&self) -> &http::Extensions { self.request.extensions() } /// Mutably access the extensions to the context. pub fn extensions_mut(&mut self) -> &mut http::Extensions { self.request.extensions_mut() } }