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
use std::any::{Any, TypeId};
use std::collections::HashMap;
use std::fmt::{self, Formatter};
/// `Depot` is for store temp data of current request.
///
/// A depot instance is created when server get a request from client. The depot will dropped when all process
/// for this request done. For example, we can set ```current_user``` in ```set_user```, and then use this value
/// in the following middlewares and handlers.
///
/// # Example
///
/// ```no_run
/// use salvo_core::prelude::*;
///
/// #[handler]
/// async fn set_user(depot: &mut Depot) {
/// depot.insert("user", "client");
/// }
/// #[handler]
/// async fn hello(depot: &mut Depot) -> String {
/// format!("Hello {}", depot.get::<&str>("user").copied().unwrap_or_default())
/// }
///
/// #[tokio::main]
/// async fn main() {
/// let router = Router::new().hoop(set_user).goal(hello);
/// let acceptor = TcpListener::new("0.0.0.0:5800").bind().await;
/// Server::new(acceptor).serve(router).await;
/// }
/// ```
#[derive(Default)]
pub struct Depot {
map: HashMap<String, Box<dyn Any + Send + Sync>>,
}
#[inline]
fn type_key<T: 'static>() -> String {
format!("{:?}", TypeId::of::<T>())
}
impl Depot {
/// Creates an empty `Depot`.
///
/// The depot is initially created with a capacity of 0, so it will not allocate until it is first inserted into.
#[inline]
pub fn new() -> Depot {
Depot { map: HashMap::new() }
}
/// Get reference to depot inner map.
#[inline]
pub fn inner(&self) -> &HashMap<String, Box<dyn Any + Send + Sync>> {
&self.map
}
/// Creates an empty `Depot` with the specified capacity.
///
/// The depot will be able to hold at least capacity elements without reallocating. If capacity is 0, the depot will not allocate.
#[inline]
pub fn with_capacity(capacity: usize) -> Self {
Depot {
map: HashMap::with_capacity(capacity),
}
}
/// Returns the number of elements the depot can hold without reallocating.
#[inline]
pub fn capacity(&self) -> usize {
self.map.capacity()
}
/// Inject a value into the depot.
#[inline]
pub fn inject<V: Any + Send + Sync>(&mut self, value: V) -> &mut Self {
self.map.insert(type_key::<V>(), Box::new(value));
self
}
/// Obtain a reference to a value previous inject to the depot.
///
/// Returns `Err(None)` if value is not present in depot.
/// Returns `Err(Some(Box<dyn Any + Send + Sync>))` if value is present in depot but downcast failed.
#[inline]
pub fn obtain<T: Any + Send + Sync>(&self) -> Result<&T, Option<&Box<dyn Any + Send + Sync>>> {
self.get(&type_key::<T>())
}
/// Obtain a mutable reference to a value previous inject to the depot.
///
/// Returns `Err(None)` if value is not present in depot.
/// Returns `Err(Some(Box<dyn Any + Send + Sync>))` if value is present in depot but downcast failed.
#[inline]
pub fn obtain_mut<T: Any + Send + Sync>(&mut self) -> Result<&mut T, Option<&mut Box<dyn Any + Send + Sync>>> {
self.get_mut(&type_key::<T>())
}
/// Inserts a key-value pair into the depot.
#[inline]
pub fn insert<K, V>(&mut self, key: K, value: V) -> &mut Self
where
K: Into<String>,
V: Any + Send + Sync,
{
self.map.insert(key.into(), Box::new(value));
self
}
/// Check is there a value stored in depot with this key.
#[inline]
pub fn contains_key(&self, key: &str) -> bool {
self.map.contains_key(key)
}
/// Check is there a value is injected to the depot.
///
/// **Note: This is only check injected value.**
#[inline]
pub fn contains<T: Any + Send + Sync>(&self) -> bool {
self.map.contains_key(&type_key::<T>())
}
/// Immutably borrows value from depot.
///
/// Returns `Err(None)` if value is not present in depot.
/// Returns `Err(Some(Box<dyn Any + Send + Sync>))` if value is present in depot but downcast failed.
#[inline]
pub fn get<V: Any + Send + Sync>(&self, key: &str) -> Result<&V, Option<&Box<dyn Any + Send + Sync>>> {
if let Some(value) = self.map.get(key) {
value.downcast_ref::<V>().ok_or(Some(value))
} else {
Err(None)
}
}
/// Mutably borrows value from depot.
///
/// Returns `Err(None)` if value is not present in depot.
/// Returns `Err(Some(Box<dyn Any + Send + Sync>))` if value is present in depot but downcast failed.
pub fn get_mut<V: Any + Send + Sync>(
&mut self,
key: &str,
) -> Result<&mut V, Option<&mut Box<dyn Any + Send + Sync>>> {
if let Some(value) = self.map.get_mut(key) {
if value.downcast_mut::<V>().is_some() {
Ok(value.downcast_mut::<V>().expect("downcast_mut shuold not be failed"))
} else {
Err(Some(value))
}
} else {
Err(None)
}
}
/// Remove value from depot and returning the value at the key if the key was previously in the depot.
#[inline]
pub fn remove<V: Any + Send + Sync>(&mut self, key: &str) -> Result<V, Option<Box<dyn Any + Send + Sync>>> {
if let Some(value) = self.map.remove(key) {
value.downcast::<V>().map(|b| *b).map_err(Some)
} else {
Err(None)
}
}
/// Delete the key from depot, if the key is not present, return `false`.
#[inline]
pub fn delete(&mut self, key: &str) -> bool {
self.map.remove(key).is_some()
}
/// Remove value from depot and returning the value if the type was previously in the depot.
#[inline]
pub fn scrape<T: Any + Send + Sync>(&mut self) -> Result<T, Option<Box<dyn Any + Send + Sync>>> {
self.remove(&type_key::<T>())
}
}
impl fmt::Debug for Depot {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_struct("Depot").field("keys", &self.map.keys()).finish()
}
}
#[cfg(test)]
mod test {
use crate::prelude::*;
use crate::test::{ResponseExt, TestClient};
use super::*;
#[test]
fn test_depot() {
let mut depot = Depot::with_capacity(6);
assert!(depot.capacity() >= 6);
depot.insert("one", "ONE".to_owned());
assert!(depot.contains_key("one"));
assert_eq!(depot.get::<String>("one").unwrap(), &"ONE".to_owned());
assert_eq!(depot.get_mut::<String>("one").unwrap(), &mut "ONE".to_owned());
}
#[tokio::test]
async fn test_middleware_use_depot() {
#[handler]
async fn set_user(req: &mut Request, depot: &mut Depot, res: &mut Response, ctrl: &mut FlowCtrl) {
depot.insert("user", "client");
ctrl.call_next(req, depot, res).await;
}
#[handler]
async fn hello(depot: &mut Depot) -> String {
format!("Hello {}", depot.get::<&str>("user").copied().unwrap_or_default())
}
let router = Router::new().hoop(set_user).goal(hello);
let service = Service::new(router);
let content = TestClient::get("http://127.0.0.1:5800")
.send(&service)
.await
.take_string()
.await
.unwrap();
assert_eq!(content, "Hello client");
}
}