use std::ffi::c_void;
use std::marker::PhantomData;
pub struct OpaqueHandle<T: ?Sized> {
_marker: PhantomData<T>,
}
impl<T> OpaqueHandle<T> {
#[allow(clippy::new_ret_no_self)] pub fn new(value: T) -> *mut c_void {
Box::into_raw(Box::new(value)) as *mut c_void
}
pub unsafe fn from_raw(ptr: *mut c_void) {
if ptr.is_null() {
return;
}
unsafe { drop(Box::from_raw(ptr as *mut T)) };
}
pub fn into_raw(value: T) -> *mut c_void {
Self::new(value)
}
}
impl<T: ?Sized> OpaqueHandle<T> {
pub unsafe fn borrow_raw<'a>(ptr: *mut c_void) -> &'a mut T
where
T: Sized,
{
debug_assert!(
!ptr.is_null(),
"OpaqueHandle::borrow_raw on a NULL pointer is a plugin bug"
);
unsafe { &mut *(ptr as *mut T) }
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn roundtrips_a_value() {
let ptr = OpaqueHandle::new(42u32);
let borrowed = unsafe { OpaqueHandle::<u32>::borrow_raw(ptr) };
assert_eq!(*borrowed, 42);
*borrowed = 7;
let borrowed2 = unsafe { OpaqueHandle::<u32>::borrow_raw(ptr) };
assert_eq!(*borrowed2, 7);
unsafe {
OpaqueHandle::<u32>::from_raw(ptr);
}
}
#[test]
fn from_raw_on_null_is_a_noop() {
unsafe {
OpaqueHandle::<u32>::from_raw(std::ptr::null_mut());
}
}
#[test]
fn roundtrips_a_struct() {
struct State {
count: u32,
label: String,
}
let ptr = OpaqueHandle::new(State {
count: 0,
label: "hash".to_string(),
});
let s = unsafe { OpaqueHandle::<State>::borrow_raw(ptr) };
s.count += 1;
assert_eq!(s.label, "hash");
assert_eq!(s.count, 1);
unsafe {
OpaqueHandle::<State>::from_raw(ptr);
}
}
}