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
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
// This code is functionally equivalent to `Extensions` in the `http` crate. Examples
// have been updated to be more relevant for smithy use, the interface has been made public,
// and the doc comments have been updated to reflect how the property bag is used in the SDK.
// Additionally, optimizations around the HTTP use case have been removed in favor or simpler code.
use std::any::{Any, TypeId};
use std::collections::HashMap;
use std::fmt;
use std::hash::{BuildHasherDefault, Hasher};
use std::ops::{Deref, DerefMut};
use std::sync::{Arc, Mutex};
type AnyMap = HashMap<TypeId, Box<dyn Any + Send + Sync>, BuildHasherDefault<IdHasher>>;
// With TypeIds as keys, there's no need to hash them. They are already hashes
// themselves, coming from the compiler. The IdHasher just holds the u64 of
// the TypeId, and then returns it, instead of doing any bit fiddling.
#[derive(Default)]
struct IdHasher(u64);
impl Hasher for IdHasher {
#[inline]
fn finish(&self) -> u64 {
self.0
}
fn write(&mut self, _: &[u8]) {
unreachable!("TypeId calls write_u64");
}
#[inline]
fn write_u64(&mut self, id: u64) {
self.0 = id;
}
}
/// A type-map of configuration data.
///
/// `PropertyBag` can be used by `Request` and `Response` to store
/// data used to configure the SDK request pipeline.
#[derive(Default)]
pub struct PropertyBag {
// In http where this property bag is usually empty, this makes sense. We will almost always put
// something in the bag, so we could consider removing the layer of indirection.
map: AnyMap,
}
impl PropertyBag {
/// Create an empty `PropertyBag`.
#[inline]
pub fn new() -> PropertyBag {
PropertyBag {
map: AnyMap::default(),
}
}
/// Insert a type into this `PropertyBag`.
///
/// If a value of this type already existed, it will be returned.
///
/// # Examples
///
/// ```
/// # use aws_smithy_http::property_bag::PropertyBag;
/// let mut props = PropertyBag::new();
///
/// #[derive(Debug, Eq, PartialEq)]
/// struct Endpoint(&'static str);
/// assert!(props.insert(Endpoint("dynamo.amazon.com")).is_none());
/// assert_eq!(
/// props.insert(Endpoint("kinesis.amazon.com")),
/// Some(Endpoint("dynamo.amazon.com"))
/// );
/// ```
pub fn insert<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T> {
self.map
.insert(TypeId::of::<T>(), Box::new(val))
.and_then(|boxed| {
(boxed as Box<dyn Any + 'static>)
.downcast()
.ok()
.map(|boxed| *boxed)
})
}
/// Get a reference to a type previously inserted on this `PropertyBag`.
///
/// # Examples
///
/// ```
/// # use aws_smithy_http::property_bag::PropertyBag;
/// let mut props = PropertyBag::new();
/// assert!(props.get::<i32>().is_none());
/// props.insert(5i32);
///
/// assert_eq!(props.get::<i32>(), Some(&5i32));
/// ```
pub fn get<T: Send + Sync + 'static>(&self) -> Option<&T> {
self.map
.get(&TypeId::of::<T>())
.and_then(|boxed| (&**boxed as &(dyn Any + 'static)).downcast_ref())
}
/// Get a mutable reference to a type previously inserted on this `PropertyBag`.
///
/// # Examples
///
/// ```
/// # use aws_smithy_http::property_bag::PropertyBag;
/// let mut props = PropertyBag::new();
/// props.insert(String::from("Hello"));
/// props.get_mut::<String>().unwrap().push_str(" World");
///
/// assert_eq!(props.get::<String>().unwrap(), "Hello World");
/// ```
pub fn get_mut<T: Send + Sync + 'static>(&mut self) -> Option<&mut T> {
self.map
.get_mut(&TypeId::of::<T>())
.and_then(|boxed| (&mut **boxed as &mut (dyn Any + 'static)).downcast_mut())
}
/// Remove a type from this `PropertyBag`.
///
/// If a value of this type existed, it will be returned.
///
/// # Examples
///
/// ```
/// # use aws_smithy_http::property_bag::PropertyBag;
/// let mut props = PropertyBag::new();
/// props.insert(5i32);
/// assert_eq!(props.remove::<i32>(), Some(5i32));
/// assert!(props.get::<i32>().is_none());
/// ```
pub fn remove<T: Send + Sync + 'static>(&mut self) -> Option<T> {
self.map.remove(&TypeId::of::<T>()).and_then(|boxed| {
(boxed as Box<dyn Any + 'static>)
.downcast()
.ok()
.map(|boxed| *boxed)
})
}
/// Clear the `PropertyBag` of all inserted extensions.
///
/// # Examples
///
/// ```
/// # use aws_smithy_http::property_bag::PropertyBag;
/// let mut props = PropertyBag::new();
/// props.insert(5i32);
/// props.clear();
///
/// assert!(props.get::<i32>().is_none());
#[inline]
pub fn clear(&mut self) {
self.map.clear();
}
}
impl fmt::Debug for PropertyBag {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("PropertyBag").finish()
}
}
/// A wrapper of [`PropertyBag`] that can be safely shared across threads and cheaply cloned.
///
/// To access properties, use either `acquire` or `acquire_mut`. This can be one line for
/// single property accesses, for example:
/// ```rust
/// # use aws_smithy_http::property_bag::SharedPropertyBag;
/// # let properties = SharedPropertyBag::new();
/// let my_string = properties.acquire().get::<String>();
/// ```
///
/// For multiple accesses, the acquire result should be stored as a local since calling
/// acquire repeatedly will be slower than calling it once:
/// ```rust
/// # use aws_smithy_http::property_bag::SharedPropertyBag;
/// # let properties = SharedPropertyBag::new();
/// let props = properties.acquire();
/// let my_string = props.get::<String>();
/// let my_vec = props.get::<Vec<String>>();
/// ```
///
/// Use `acquire_mut` to insert properties into the bag:
/// ```rust
/// # use aws_smithy_http::property_bag::SharedPropertyBag;
/// # let properties = SharedPropertyBag::new();
/// properties.acquire_mut().insert("example".to_string());
/// ```
#[derive(Clone, Debug, Default)]
pub struct SharedPropertyBag(Arc<Mutex<PropertyBag>>);
impl SharedPropertyBag {
/// Create an empty `SharedPropertyBag`.
pub fn new() -> Self {
SharedPropertyBag(Arc::new(Mutex::new(PropertyBag::new())))
}
/// Acquire an immutable reference to the property bag.
pub fn acquire(&self) -> impl Deref<Target = PropertyBag> + '_ {
self.0.lock().unwrap()
}
/// Acquire a mutable reference to the property bag.
pub fn acquire_mut(&self) -> impl DerefMut<Target = PropertyBag> + '_ {
self.0.lock().unwrap()
}
}
impl From<PropertyBag> for SharedPropertyBag {
fn from(bag: PropertyBag) -> Self {
SharedPropertyBag(Arc::new(Mutex::new(bag)))
}
}
#[cfg(test)]
#[test]
fn test_extensions() {
#[derive(Debug, PartialEq)]
struct MyType(i32);
let mut extensions = PropertyBag::new();
extensions.insert(5i32);
extensions.insert(MyType(10));
assert_eq!(extensions.get(), Some(&5i32));
assert_eq!(extensions.get_mut(), Some(&mut 5i32));
assert_eq!(extensions.remove::<i32>(), Some(5i32));
assert!(extensions.get::<i32>().is_none());
assert_eq!(extensions.get::<bool>(), None);
assert_eq!(extensions.get(), Some(&MyType(10)));
}