alef 0.25.39

Opinionated polyglot binding generator for Rust libraries
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

/// Opaque handle to a {{ service_name }} service instance.
/// Allocated by {{ new_fn_name }}(), freed by {{ free_fn_name }}().
///
/// `inner` is `Option<Box<…>>` so a `Finalize` entrypoint can `.take()` the
/// owner out without invalidating the C pointer. Consumers must still call
/// `{{ free_fn_name }}()` after a `Finalize` returns to release the opaque
/// shell; the shell drops trivially when `inner` is `None`.
#[repr(C)]
pub struct {{ opaque_name }} {
    inner: Option<Box<{{ owner_path }}>>,
}

/// Allocate a new {{ service_name }} instance.
///
/// # Safety
/// The returned pointer must be freed via {{ free_fn_name }}().
/// Never access the pointer after freeing it.
#[no_mangle]
pub extern "C" fn {{ new_fn_name }}() -> *mut {{ opaque_name }} {
    let owner = {{ owner_path }}::{{ constructor_name }}();
    Box::into_raw(Box::new({{ opaque_name }} {
        inner: Some(Box::new(owner)),
    }))
}

/// Free a {{ service_name }} instance allocated by {{ new_fn_name }}().
///
/// # Safety
/// - `ptr` must have been allocated by {{ new_fn_name }}().
/// - After this call, `ptr` is invalid and must not be dereferenced.
/// - Calling this twice on the same pointer causes undefined behavior.
/// - Safe to call even after a `Finalize` entrypoint has emptied `inner`.
#[no_mangle]
pub extern "C" fn {{ free_fn_name }}(ptr: *mut {{ opaque_name }}) {
    if !ptr.is_null() {
        // SAFETY: ptr was allocated by into_raw above;
        // we are the sole owner and this is the final drop.
        unsafe {
            drop(Box::from_raw(ptr));
        }
    }
}