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
//! Simple, Lighweight and "not" thread safe Singleton instance but it depend on the usage,
//! feel free to make thread safe wrapper
//!
//! Currently it can :
//! * Set value to the instance with type.
//! * Get reference value to the instance with type.
//! * Get mutable reference value to the instance with type.
//! * Work at no_std environment
//!
//! ### Examples
//! ```
//! fn main() {
//! // Create the Singleton instance
//! let mut instance = singly::Singleton::new();
//!
//! /// Set the i32 type to 12
//! instance.set(12i32);
//!
//! /// Get mutable reference i32 type and set it to 14
//! let a = instance.get_mut::<i32>();
//! *a = 14;
//!
//! assert_eq!(instance.get::<i32>(), &14);
//!
//! }
//! ```
//!
//! ## Some tips for Thread Safety
//!
//! * Wrap your type with [`Arc`] and then [`Mutex`] or [`RwLock`]
//! * If you can avoid using [`Singleton::get_mut`] or get [`Singleton::try_get_mut`], or you know
//! what you are doing
//! * For [`Singleton`] instance in static context please use [`Mutex`]
//!
//! If none of this above not introduce it will definitely going to be data race
//!
//! ### Examples Concurrent Situation
//! ```
//! use std::{
//! sync::{Arc, Mutex},
//! thread::spawn,
//! };
//!
//! use singly::Singleton;
//!
//! struct Counter(i32);
//!
//! // Notice on the type
//! type ArcMutexCounter = Arc<Mutex<Counter>>;
//!
//! fn main() {
//! let mut instance = Singleton::new();
//! let counter = Arc::new(Mutex::new(Counter(0)));
//! instance.set(counter);
//!
//! let mut handles = vec![];
//! for _ in 0..10 {
//! let counter_clone: ArcMutexCounter = Arc::clone(instance.get::<ArcMutexCounter>());
//! let handle = spawn(move || {
//! let mut counter = counter_clone.lock().unwrap();
//! (*counter).0 += 1;
//! });
//! handles.push(handle);
//! }
//!
//! let _ = handles
//! .into_iter()
//! .map(|handle| handle.join())
//! .collect::<Result<Vec<_>, _>>();
//!
//! let counter = instance.get::<ArcMutexCounter>().lock().unwrap().0;
//! assert_eq!(counter, 10);
//! }
//! ```
//!
//! There is example on
//! [integration_test.rs](https://github.com/UnknownRori/singly-rs/blob/main/tests/integration_test.rs)
#![no_std]
use core::{
any::{Any, TypeId},
borrow::{Borrow, BorrowMut},
};
use inner::Inner;
extern crate alloc;
mod inner;
#[derive(Debug)]
/// Base instance for Singleton storage
pub struct Singleton {
/// Property to store any type of value in here
/// It only allow single type every value
/// If it insert with same type it will silently overwrite the old value
storage: hashbrown::HashMap<TypeId, Inner>,
}
impl Singleton {
/// Creates an empty Singleton Storage
///
/// # Examples
///
/// ```
/// use singly::Singleton;
///
/// let mut instance = Singleton::new();
///
/// instance.set(32i32);
/// instance.set(12f32);
///
/// assert_eq!(instance.get::<i32>(), &32);
/// assert_eq!(instance.get::<f32>(), &12f32);
/// ```
pub fn new() -> Self {
Self {
storage: hashbrown::HashMap::new(),
}
}
/// Creates an empty Singleton Storage with specified capacity
///
/// # Examples
///
/// ```
/// use singly::Singleton;
///
/// let mut instance = Singleton::with_capacity(2);
///
/// instance.set(32i32);
/// instance.set(12f32);
///
/// assert_eq!(instance.get::<i32>(), &32);
/// assert_eq!(instance.get::<f32>(), &12f32);
/// ```
pub fn with_capacity(capacity: usize) -> Self {
Self {
storage: hashbrown::HashMap::with_capacity(capacity),
}
}
/// Store the data to [`Singleton`] storage
/// Will silently overwrite old value if any
pub fn set<T: Any>(&mut self, data: T) {
self.storage.insert(TypeId::of::<T>(), Inner::new(data));
}
/// Get reference to data from global storage.
/// Will return None if there is no data available with this type.
pub fn try_get<T: Any>(&self) -> Option<&T> {
self.storage
.get(&TypeId::of::<T>())
.and_then(|data| data.get().downcast_ref::<T>().map(|data| data.borrow()))
}
/// Get reference to data from global storage.
///
/// ## Panic
///
/// May panic if there is no data available with this type
pub fn get<T: Any>(&self) -> &T {
self.try_get::<T>().unwrap()
}
/// Get mutabler eference to data from global storage.
/// Will return None if there is no data available with this type.
pub fn try_get_mut<T: Any>(&mut self) -> Option<&mut T> {
self.storage.get_mut(&TypeId::of::<T>()).and_then(|data| {
data.get_mut()
.downcast_mut::<T>()
.map(|data| data.borrow_mut() as &mut T)
})
}
/// Get mutable reference to data from global storage.
///
/// ## Panic
///
/// May panic if there is no data available with this type
pub fn get_mut<T: Any>(&mut self) -> &mut T {
self.try_get_mut::<T>().unwrap()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn base_use() {
let mut instance = Singleton::new();
instance.set(32i32);
instance.set(12f32);
assert_eq!(instance.get::<i32>(), &32);
assert_eq!(instance.get::<f32>(), &12f32);
}
#[test]
fn set_ref_mut_value() {
let mut instance = Singleton::new();
instance.set(12i32);
let a = instance.try_get_mut::<i32>().unwrap();
*a = 13;
assert_eq!(instance.get::<i32>(), &13);
}
}