boltffi_core 0.22.1

Core runtime types for BoltFFI - high-performance FFI bindings generator
Documentation 
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

use std::ffi::c_void;
use std::sync::Arc;

#[repr(C)]
#[derive(Clone, Copy)]
pub struct CallbackHandle {
    handle: u64,
    vtable: *const c_void,
}

unsafe impl Send for CallbackHandle {}
unsafe impl Sync for CallbackHandle {}

impl CallbackHandle {
    pub const NULL: Self = Self {
        handle: 0,
        vtable: std::ptr::null(),
    };

    #[inline]
    pub const fn new(handle: u64, vtable: *const c_void) -> Self {
        Self { handle, vtable }
    }

    #[inline]
    pub fn handle(&self) -> u64 {
        self.handle
    }

    #[inline]
    pub fn vtable(&self) -> *const c_void {
        self.vtable
    }

    #[inline]
    pub fn is_null(&self) -> bool {
        #[cfg(target_arch = "wasm32")]
        {
            return self.handle == 0;
        }

        #[cfg(not(target_arch = "wasm32"))]
        {
            self.handle == 0 || self.vtable.is_null()
        }
    }

    #[inline]
    #[cfg(target_arch = "wasm32")]
    pub fn from_wasm_handle(handle: u32) -> Self {
        Self {
            handle: handle as u64,
            vtable: std::ptr::null(),
        }
    }
}

pub trait FromCallbackHandle {
    unsafe fn arc_from_callback_handle(handle: CallbackHandle) -> Arc<Self>;
    unsafe fn box_from_callback_handle(handle: CallbackHandle) -> Box<Self>;
}

pub trait CallbackForeignType {
    type Foreign: FromCallbackHandle;
}

impl Default for CallbackHandle {
    fn default() -> Self {
        Self::NULL
    }
}

impl std::fmt::Debug for CallbackHandle {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("CallbackHandle")
            .field("handle", &self.handle)
            .field("vtable", &self.vtable)
            .finish()
    }
}

#[cfg(target_arch = "wasm32")]
#[unsafe(no_mangle)]
pub extern "C" fn boltffi_create_callback_handle(js_handle: u32) -> u32 {
    js_handle
}

#[cfg(target_arch = "wasm32")]
pub struct WasmCallbackOwner {
    handle: u32,
    free_fn: unsafe extern "C" fn(u32),
}

#[cfg(target_arch = "wasm32")]
impl WasmCallbackOwner {
    #[inline]
    pub fn new(handle: u32, free_fn: unsafe extern "C" fn(u32)) -> Self {
        Self { handle, free_fn }
    }

    #[inline]
    pub fn handle(&self) -> u32 {
        self.handle
    }
}

#[cfg(target_arch = "wasm32")]
impl Drop for WasmCallbackOwner {
    fn drop(&mut self) {
        unsafe { (self.free_fn)(self.handle) }
    }
}

#[cfg(target_arch = "wasm32")]
unsafe impl Send for WasmCallbackOwner {}

#[cfg(target_arch = "wasm32")]
unsafe impl Sync for WasmCallbackOwner {}

#[cfg(test)]
mod tests {
    use super::CallbackHandle;

    #[cfg(not(target_arch = "wasm32"))]
    #[test]
    fn native_handle_with_null_vtable_is_null() {
        let handle = CallbackHandle::new(7, std::ptr::null());
        assert!(handle.is_null());
    }

    #[cfg(target_arch = "wasm32")]
    #[test]
    fn wasm_handle_is_null_only_when_handle_is_zero() {
        let handle = CallbackHandle::from_wasm_handle(7);
        assert!(!handle.is_null());
        assert!(CallbackHandle::from_wasm_handle(0).is_null());
    }
}