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
use std::{
any::{type_name, TypeId},
collections::HashMap,
marker::PhantomData,
ptr::NonNull,
};
use crate::{BindError, ProvideFn, Provider, Service, UnbindError};
/// A context in which to store providers for services
pub struct Context<'pcx> {
/// Map `Service` `TypeId`s to a type-erased provider
//
// Note: Unfortunately, https://github.com/rust-lang/rust/issues/10389 is an I-unsound bug to
// keep an eye on. TL;DR: TypeId hash collisions are possible and there have been some (obscure)
// examples of this in the past.
providers: HashMap<TypeId, DynProvider>,
_phantom: PhantomData<&'pcx ()>,
}
impl Context<'_> {
/// Create an empty context
pub fn new() -> Self {
Self {
providers: HashMap::new(),
_phantom: PhantomData,
}
}
/// Create a sub-context
///
/// The retuned context will contain the same elements as the parent context and any elements
/// added to the sub context will not be visible on the original. However, the underlying
/// providers that were added before this call are shared between the two contexts.
pub fn scoped(&self) -> Context<'_> {
// Notes:
// - We are cloning the pointers, not the underlying data
// - Provider expects a shared reference
// - DynProvider's clone implementation skips the drop function for clones
Context {
providers: self.providers.clone(),
_phantom: PhantomData,
}
}
/// Register a new provider for the service `S`
///
/// # Panics
/// If the service binding fails. See [`try_bind_with`](Self::try_bind_with) for a fallible
/// version of this function.
#[track_caller]
pub fn bind_with<'cx, S: Service>(&'cx mut self, provider: impl Provider<'cx, S>) {
if let Err(err) = self.try_bind_with::<S>(provider) {
panic!("{}", err)
}
}
/// Register a function as a provider for the service `S`
///
/// # Panics
/// If the service binding fails. See [`try_bind_fn`](Self::try_bind_fn) for a fallible version
/// of this function.
#[track_caller]
pub fn bind_fn<'cx, S: Service>(
&'cx mut self,
provider_fn: impl Fn(&'cx Context) -> S::Output<'cx> + 'cx,
) {
if let Err(err) = self.try_bind_fn::<S>(provider_fn) {
panic!("{}", err)
}
}
/// Bind the provider `P` to the service `S`
///
/// # Panics
/// If the service binding fails. See [`try_bind`](Self::try_bind) for a fallible version of
/// this function.
#[track_caller]
pub fn bind<'cx, S, P>(&'cx mut self)
where
S: Service,
P: Provider<'cx, S> + Default,
{
if let Err(err) = self.try_bind::<S, P>() {
panic!("{}", err)
}
}
/// Delete the provider bound to the service `S`
///
/// # Panics
/// If the service unbinding fails. See [`try_unbind`](Self::try_unbind) for a fallible version
/// of this function.
#[track_caller]
pub fn unbind<S>(&mut self)
where
S: Service,
{
if let Err(err) = self.try_unbind::<S>() {
panic!("{}", err)
}
}
/// Resolve the service `S` based on the already registered providers
///
/// # Panics
/// If no provider is registered for this service. See [`try_resolve`](Self::try_resolve) for a
/// fallible version of this function.
#[track_caller]
pub fn resolve<S: Service>(&self) -> S::Output<'_> {
match self.try_resolve::<S>() {
Some(s) => s,
None => panic!("no provider for service `{}`", type_name::<S>()),
}
}
/// Try to register a new provider for the service `S`
///
/// # Fails
/// This function will fail if a provider is already bound to the service.
///
/// See [`bind_with`](Self::bind_with) for the panicking version of this function.
pub fn try_bind_with<'cx, S: Service>(
&'cx mut self,
provider: impl Provider<'cx, S>,
) -> Result<(), BindError> {
use std::collections::hash_map::Entry::*;
match self.providers.entry(TypeId::of::<S>()) {
Vacant(e) => {
// SAFETY:
// - Due to the api provided by `Context`, all clones of `DynProvider` _will_ be
// dropped before the original instance is dropped
e.insert(unsafe { DynProvider::new(provider) });
Ok(())
}
Occupied(_) => Err(BindError::ServiceBound(std::any::type_name::<S>())),
}
}
/// Try to register a function as a provider for the service `S`
///
/// # Fails
/// This function will fail if a provider is already bound to the service.
///
/// See [`bind_fn`](Self::bind_fn) for the panicking version of this function.
#[inline(always)]
pub fn try_bind_fn<'cx, S: Service>(
&'cx mut self,
provider_fn: impl Fn(&'cx Context) -> S::Output<'cx> + 'cx,
) -> Result<(), BindError> {
self.try_bind_with::<S>(provider_fn)
}
/// Try to bind the provider `P` to the service `S`
///
/// # Fails
/// This function will fail if a provider is already bound to the service.
///
/// See [`bind`](Self::bind) for the panicking version of this function.
#[inline(always)]
pub fn try_bind<'cx, S, P>(&'cx mut self) -> Result<(), BindError>
where
S: Service,
P: Provider<'cx, S> + Default,
{
self.try_bind_with(P::default())
}
/// Try to delete the provider bound to the service `S`
///
/// # Fails
/// This function will fail if no provider is bound to the service.
///
/// See [`unbind`](Self::unbind) for the panicking version of this function.
pub fn try_unbind<S>(&mut self) -> Result<(), UnbindError>
where
S: Service,
{
match self.providers.remove(&TypeId::of::<S>()) {
Some(_) => Ok(()),
None => Err(UnbindError::ServiceUnbound(type_name::<S>())),
}
}
/// Try to resolve the service `S` based on the already registered providers
///
/// # Fails
/// This function will fail if no provider is bound to the service.
///
/// See [`unbind`](Self::unbind) for the panicking version of this function.
pub fn try_resolve<S: Service>(&self) -> Option<S::Output<'_>> {
let provider = self.providers.get(&TypeId::of::<S>())?;
// SAFETY:
// - We know that the provider was created for the service `S`, since it came from the
// `self.providers` map
Some(unsafe { provider.provide::<S>(self) })
}
}
impl Default for Context<'_> {
#[inline(always)]
fn default() -> Self {
Self::new()
}
}
struct DynProvider {
/// Type-erased pointer to the underlying provider data
this: NonNull<()>,
/// Type-erased function pointer to the provider's `provide` implementation
provide_fn: NonNull<()>,
/// Pointer to the provider's `drop` implementation
//
// SAFETY:
// - Must only be called with a valid `self.this` pointer
drop_fn: Option<unsafe fn(*mut ())>,
}
impl DynProvider {
/// Create a `DynProvider` for the service `S`
///
/// SAFETY:
/// - This instance must live as long as all of its clones
unsafe fn new<'cx, S, P>(provider: P) -> Self
where
S: Service,
P: Provider<'cx, S>,
{
unsafe fn drop_provider<P>(this: *mut ()) {
std::mem::drop(Box::from_raw(this as *mut P));
}
// Create a pointer to a specialized `drop` function and store it.
let drop_fn = Some(drop_provider::<P> as _);
// Get the P::provide function pointer and store a type-erased version of it
//
// SAFETY:
// - fn pointers are always non-null
let provide_fn = unsafe { NonNull::new_unchecked(P::provide as fn(_, _) -> _ as _) };
// Create the `this` pointer.
//
// SAFETY:
// - A `Box`'s pointer is always guaranteed to be non-null
let this = unsafe { NonNull::new_unchecked(Box::into_raw(Box::new(provider)) as *mut _) };
Self {
this,
drop_fn,
provide_fn,
}
}
/// Run the provider
///
/// SAFETY:
/// - The `DynProvider` was created for the service `S`
unsafe fn provide<'cx, S>(&'cx self, cx: &'cx Context) -> S::Output<'cx>
where
S: Service,
{
let this = self.this.as_ptr() as *const ();
let provide_fn: ProvideFn<'cx, S> = std::mem::transmute(self.provide_fn);
provide_fn(this, cx)
}
}
impl Clone for DynProvider {
fn clone(&self) -> Self {
Self {
this: self.this,
provide_fn: self.provide_fn,
drop_fn: None, // drop should only run on the original instance
}
}
}
impl Drop for DynProvider {
fn drop(&mut self) {
if let Some(drop_fn) = self.drop_fn {
// SAFETY:
// - `drop_fn` can only be called with `self.this`, which it is.
// - We know drop has not been called because of the safety guarantees on new(), which
// means that `self.this` points to valid memory.
unsafe { (drop_fn)(self.this.as_ptr()) }
}
}
}