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
//! # stack-any
//!
//! A library that provides a type that owns same size type on the stack for type erasure.
//!
//! ## Usage
//!
//! Same size type on the stack for type erasure.
//!
//! ```
//! let stack_0 = stack_any::stack_any!(Vec<i32>, vec![0, 1, 2]);
//! let stack_1 = stack_any::stack_any!(Vec<char>, vec!['a', 'b', 'c']);
//! let mut stacks = [stack_0, stack_1];
//!
//! stacks[0].downcast_mut::<Vec<i32>>().push(3);
//! stacks[1].downcast_mut::<Vec<char>>().push('d');
//!
//! assert_eq!(stacks[0].downcast_ref::<Vec<i32>>(), &vec![0, 1, 2, 3]);
//! assert_eq!(stacks[1].downcast_ref::<Vec<char>>(), &vec!['a', 'b', 'c', 'd']);
//! ```
//!
//! Different size type on the stack for type erasure.
//!
//! ```
//! let mut stack = stack_any::StackAny::<8>::new(0);
//!
//! *stack.downcast_mut::<i32>() = 100;
//! assert_eq!(stack.downcast_ref::<i32>(), &100);
//!
//! *stack.downcast_mut::<i64>() = 200;
//! assert_eq!(stack.downcast_ref::<i64>(), &200);
//! ```
#![cfg_attr(not(feature = "std"), no_std)]
/// A convertible type that owns a stack allocation of `N` size.
#[derive(Debug)]
pub struct StackAny<const N: usize> {
bytes: [core::mem::MaybeUninit<u8>; N],
size: usize,
}
impl<const N: usize> StackAny<N> {
/// Allocates N-size memory on the stack and then places `value` into it.
///
/// # Panics
///
/// Panics if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let five = stack_any::StackAny::<{ std::mem::size_of::<i32>() }>::new(5);
/// ```
#[inline]
pub fn new<T>(value: T) -> Self
where
T: core::any::Any,
{
Self::try_new(value).expect("T size is larger than N")
}
/// Allocates N-size memory on the stack and then places `value` into it.
/// Returns None if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let five = stack_any::StackAny::<{ std::mem::size_of::<i32>() }>::try_new(5);
/// ```
pub fn try_new<T>(value: T) -> Option<Self>
where
T: core::any::Any,
{
if N < core::mem::size_of::<T>() {
return None;
}
let mut slf = Self {
bytes: [core::mem::MaybeUninit::uninit(); N],
size: core::mem::size_of::<T>(),
};
let src = &value as *const _ as *const _;
let dst = slf.bytes.as_mut_ptr();
unsafe { core::ptr::copy_nonoverlapping(src, dst, slf.size) };
core::mem::forget(value);
Some(slf)
}
/// Attempt to return reference to the inner value as a concrete type.
///
/// # Panics
///
/// Panics if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let five = stack_any::stack_any!(i32, 5);
/// assert_eq!(five.downcast_ref::<i32>(), &5);
/// ```
#[inline]
pub fn downcast_ref<T>(&self) -> &T
where
T: core::any::Any,
{
self.try_downcast_ref().expect("T size is larger than N")
}
/// Attempt to return reference to the inner value as a concrete type.
/// Returns None if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let five = stack_any::stack_any!(i32, 5);
/// assert_eq!(five.try_downcast_ref::<i32>(), Some(&5));
/// assert_eq!(five.try_downcast_ref::<i64>(), None);
/// ```
pub fn try_downcast_ref<T>(&self) -> Option<&T>
where
T: core::any::Any,
{
if N < core::mem::size_of::<T>() {
return None;
}
let ptr = self.bytes.as_ptr();
Some(unsafe { &*(ptr as *const T) })
}
/// Attempt to return mutable reference to the inner value as a concrete type.
///
/// # Panics
///
/// Panics if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let mut five = stack_any::stack_any!(i32, 5);
/// assert_eq!(five.downcast_mut::<i32>(), &mut 5);
/// ```
pub fn downcast_mut<T>(&mut self) -> &mut T
where
T: core::any::Any,
{
self.try_downcast_mut().expect("T size is larger than N")
}
/// Attempt to return mutable reference to the inner value as a concrete type.
/// Returns None if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let mut five = stack_any::stack_any!(i32, 5);
/// assert_eq!(five.try_downcast_mut::<i32>(), Some(&mut 5));
/// assert_eq!(five.try_downcast_mut::<i64>(), None);
/// ```
pub fn try_downcast_mut<T>(&mut self) -> Option<&mut T>
where
T: core::any::Any,
{
if N < core::mem::size_of::<T>() {
return None;
}
let ptr = self.bytes.as_mut_ptr();
Some(unsafe { &mut *(ptr as *mut T) })
}
/// Attempt to downcast the stack to a concrete type.
///
/// # Panics
///
/// Panics if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let five = stack_any::stack_any!(i32, 5);
/// assert_eq!(five.downcast::<i32>(), 5);
/// ```
pub fn downcast<T>(self) -> T
where
T: core::any::Any,
{
self.try_downcast().expect("T size is larger than N")
}
/// Attempt to downcast the stack to a concrete type.
/// Returns None if `T` size is larger than N.
///
/// # Examples
///
/// ```
/// let five = stack_any::stack_any!(i32, 5);
/// assert_eq!(five.try_downcast::<i32>(), Some(5));
/// ```
pub fn try_downcast<T>(self) -> Option<T>
where
T: core::any::Any,
{
if N < core::mem::size_of::<T>() {
return None;
}
let ptr = self.bytes.as_ptr();
Some(unsafe { core::ptr::read(ptr as *const T) })
}
}
/// Allocates memory on the stack and then places value based on given type and value.
///
/// # Panics
///
/// Panics if `ty` type size is larger than `expr` type size in `stack_any!(ty, expr)`.
///
/// # Examples
///
/// ```
/// let five = stack_any::stack_any!(i32, 5);
/// ```
#[macro_export]
macro_rules! stack_any {
($type:ty, $init:expr) => {
$crate::StackAny::<{ std::mem::size_of::<$type>() }>::new::<$type>($init)
};
}